initial commit

1 files changed, 28 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index df79148..3340aa6 100644
--- a/README.rst
+++ b/README.rst
@@ -1,3 +1,31 @@
+This fork adds the *waterspill-en* (as seen on `this blog`_).
+
+.. _this blog: https://dubiousdod.org/blog/
+
+Differences from *waterspill* are:
+
+* Language is English
+* Font is larger (I have bad eyesight :) )
+* Tags aren't mentioned if you have none (both at the article level and on the sidebar)
+* It's possible to suppress category display
+* It's possible to add custom items before/after the main menu
+
+Example pelicanconf.py snippet:
+::
+
+    BEFORE_MENU = [
+        {'name':"Main site", 'url':'/'},
+    ]
+
+    AFTER_MENU = [
+        {'name':"Gallery", 'url':'http://example.com/galleries/mygallery'},
+    ]
+
+    SUPPRESS_CATEGORIES_ON_MENU = True
+    SUPPRESS_ITEM_CATEGORIES = True
+
+-------------------------------
+
 Pelican themes
 ##############