summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob L. Kreuze <zerodaysfordays@sdf.lonestar.org>2019-07-20 19:19:35 -0400
committerJakob L. Kreuze <zerodaysfordays@sdf.lonestar.org>2019-07-20 19:52:05 -0400
commitebca2cc7647cee2deb270e89d031f51f8f5bdce2 (patch)
treea2d0a1b50ee97f20c57ad04720516dc849044bdf /README.md
parentcf7f4c44c76e8674e8c2d1f8b8a515f2e844a432 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3efd450..866963c 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,16 @@
This library implements an HTML back-end for the Org generic exporter, producing
output appropriate for [Haunt's](https://dthompson.us/projects/haunt.html)
`html-reader`.
+
+To use this exporter, add the following to your Emacs configuration:
+
+```elisp
+(with-eval-after-load 'ox
+ (require 'ox-haunt))
+```
+
+As of version 0.1, only one workflow is supported. The "haunt base directory" is
+set by adding `#+HAUNT_BASE_DIR`, followed by the path, to your document, or by
+setting `ox-haunt-base-dir`. When the base directory is set, `C-c C-e s h` will
+export the Org buffer to a file in the 'posts/' subdirectory of the haunt base
+directory.