From ae7d07898e3ae1f50ff74ccc5367ae2a62f77b23 Mon Sep 17 00:00:00 2001
From: liob <hbwinther@metalabs.de>
Date: Wed, 26 Mar 2014 11:35:07 +0100
Subject: [PATCH] expanded readme

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index f6f729d..49e9fa0 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,36 @@ pandoc_reader
 =============
 
 A pandoc markdown reader plugin for pelican
+
+
+Requirements
+------------
+
+  - [pypandoc]
+  - [pandoc] in $PATH
+
+
+Installation
+------------
+
+Instructions for installation of pelican plugins can be obtained here: [manual](https://github.com/getpelican/pelican-plugins/blob/master/Readme.rst)
+
+
+Configuration
+-------------
+
+Additional command line parameters can be passed to pandoc via the PANDOC_ARGS parameter.
+
+    PANDOC_ARGS = [
+      '--mathjax',
+      '--smart',
+      '--toc',
+      '--toc-depth=2',
+      '--number-sections',
+    ]
+
+
+
+[pandoc]: http://johnmacfarlane.net/pandoc/
+[pypandoc]: https://github.com/bebraw/pypandoc
+