X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=blobdiff_plain;f=README.md;h=308094cf9a1db04644fa9906b5267c1bcf3ddcea;hp=36bddfc7beafba117e56506b64c5cc628f7fb489;hb=64d41f0ee5970b2d875880994eb287b97cad24a1;hpb=613fcb09f24655e905164be3bb0df5f0f3a96749

diff --git a/README.md b/README.md
index 36bddfc..308094c 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,10 @@
-pelican-mode is an Emacs minor mode for editing pages and posts in
+pelican-mode is an Emacs minor mode for editing articles and pages in
 [Pelican][] sites.
 
-It's intended to be used alongside [markdown-mode][] or [rst-mode][].
-It also assumes you've set up Pelican with `pelican-quickstart` or
-something like it. In particular it assumes:
+It's intended to be used alongside a major mode for the Pelican
+document. Currently supported formats are Markdown, reStructuredText,
+AsciiDoc, and Org. It also assumes you've set up Pelican with
+`pelican-quickstart` or something like it. In particular it expects:
 
  * The existence of `pelicanconf.py` and `Makefile` in some ancestor
    directory.
@@ -15,11 +16,32 @@ something like it. In particular it assumes:
 
 ## Quick Guide
 
-* `C-c P n` - Insert a post or page header
-* `C-c P p` - Remove draft status from a post (i.e. publish it)
-* `C-c P t` - Update the date field in a post/page header
-* `C-c P h` - Generate HTML output for a site (equivalent to `make html`)
-* `C-c P u` - Upload a site using rsync (equivalent to `make rsync_upload`)
+To enable by default on all text files in a Pelican site:
+
+``` emacs-lisp
+(require 'pelican-mode)
+(pelican-global-mode)
+```
+
+
+Or with `use-package` and deferred loading:
+
+``` emacs-lisp
+(use-package pelican-mode
+  :after (:any org rst markdown-mode adoc-mode)
+  :config
+  (pelican-global-mode))
+```
+
+Or, register `pelican-mode` or `pelican-mode-enable-if-site`
+as hook functions for more direct control.
+
+* `C-c = d` - Update the document’s date
+* `C-c = f` - Set a metadata field (title, category, etc.)
+* `C-c = h` - Generate HTML output for a site (equivalent to `make html`)
+* `C-c = n` - Insert a post or page header
+* `C-c = p` - Remove draft status from a post (i.e. publish it)
+* `C-c = u` - Upload a site using rsync (equivalent to `make rsync_upload`)
 
 
 ## Troubleshooting