Avoid GFM until GitWeb on git.korewanetadesu.com supports it.

[pelican-mode.git] / README.md

diff --git a/README.md b/README.md
index 0869e4b..74f8cc2 100644 (file)
--- 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.
@@ -20,6 +21,13 @@ To enable by default on all text files in a Pelican site:
     (require 'pelican-mode)
     (pelican-global-mode)
 
+Or with `use-package` and deferred loading:
+
+    (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.