From: David Bremner <bremner@unb.ca>
Date: Sun, 7 Sep 2008 20:47:52 +0000 (-0300)
Subject: update docs
X-Git-Tag: 0.1~6
X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/commitdiff_plain/48e8bd11001e67fbd2ceb8ba693377f729567bd8

update docs
---

diff --git a/README b/README
index 7a96cfa7b..20cd7d455 100644
--- a/README
+++ b/README
@@ -1,10 +1,25 @@
 
-dependencies:
+There are several steps to using this plugin.
 
-Module				Debian Package
-------	        		--------------
+- Add the plugin 'postal'  to your setup file.
+- Add the plugin 'mailbox' (packaged seperately)
+
+- update your template(s).  See examples/page.tmpl. Look for POSTAL_DIV
+
+- Manditory configuration
+
+  + postal_prefix	first part of email address i.e. user-wiki-
+  + postal_host		where to send the mail
+
+- Optional configuration:
+
+  +  postal_pagespec  what pages to add comments to.
+
+- the script filters/postal-accept.pl takes a mail message on standard in 
+  and files it in the appropriate comment box.
+
+    perl -c path/to/my/ikiwiki-setup  < mail-message
+
+This would all get somewhat easier if and when these plugins are 
+distributed with ikiwiki.
 
-IkiWiki 			ikiwiki
-Compress::LZF 			not yet
-MIME::Base64::URLSafe 		libmime-base64-urlsafe-perl
-Mail::Internet			libmailtools-perl	
\ No newline at end of file
diff --git a/TODO b/TODO
index c20ba8f7e..0f1a4313a 100644
--- a/TODO
+++ b/TODO
@@ -1,3 +1,6 @@
 * Clean up debugging cruft
-* Test VCS adding for postal-accept
+* put dependencies list in README
+* creating a comment mailbox does not add link to parent page
+  until next rebuild
+* adding a message does not refresh