From: Joe Wreschnig <joe.wreschnig@gmail.com>
Date: Mon, 7 Aug 2017 10:53:01 +0000 (+0200)
Subject: Add some usage notes.
X-Git-Tag: v20170807~9
X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=commitdiff_plain;h=9bd1bc0c098b7f3e9d556e61a3d65e68e6ce48bd;hp=4c3f5bb784e665dc66edf872086be3ff570e8f66

Add some usage notes.
---

diff --git a/README.md b/README.md
index 36bddfc..8ab9c6a 100644
--- a/README.md
+++ b/README.md
@@ -15,10 +15,19 @@ something like it. In particular it assumes:
 
 ## Quick Guide
 
+To enable by default on all text files in a Pelican site:
+
+    (require 'pelican-mode)
+    (pelican-global-mode)
+
+Or, register `pelican-mode` or `pelican-mode-enable-if-site`
+as hook functions for more direct control.
+
+* `C-c P f` - Set a metadata field (title, category, etc.)
+* `C-c P h` - Generate HTML output for a site (equivalent to `make html`)
 * `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`)
 
 
diff --git a/pelican-mode.el b/pelican-mode.el
index 1d8885e..bfd0ea6 100644
--- a/pelican-mode.el
+++ b/pelican-mode.el
@@ -38,6 +38,14 @@
 ;;    ancestor is irrelevant.
 ;;  * If the next component is ``pages'', that indicates a page
 ;;    rather than an article.
+;;
+;; To enable by default on all text files in a Pelican site:
+;;
+;;     (require 'pelican-mode)
+;;     (pelican-global-mode)
+;;
+;; Or, register `pelican-mode' or `pelican-mode-enable-if-site'
+;; as hook functions for more direct control.
 
 
 ;;; Code: