docs

README.md

@@ -6,9 +6,40 @@ Outputs a tabular calendar filled with events automatically generated
 from page titles in a certain namespace. Based on the [intersection extension][1]
 and the [FullCalendar jQuery plugin][2].
 
+Demo: [FoodHackingBase Events][3]
+
+EventCalendar expects page titles in the following format in a certain
+namespace:
+
+    yyyy/mm/dd Event Title
+
+for example
+
+    Event:2014/02/14_Synchronous_Hackathon
+
+Multi-day events can be created by setting up consecutive dates with the
+same title, like
+
+    Event:2014/02/14_Synchronous_Hackathon
+    Event:2014/02/15_Synchronous_Hackathon
+    Event:2014/02/16_Synchronous_Hackathon
+
+where the second and following pages will usually redirect to the first.
+
 To install, add following to LocalSettings.php
 
     include("$IP/extensions/yasec/EventCalendar.php");
 
+Typical invocation on a page:
+
+    <EventCalendar>
+    namespace = Recipe
+    aspectratio = 1.35
+    </EventCalendar>
+
+`aspectratio` is optional and defaults to 1.6. `max-width` is set to
+800px and can be overridden in `MediaWiki:Common.css`.
+
   [1]: http://www.mediawiki.org/wiki/Extension:DynamicPageList_(Wikimedia)
   [2]: http://arshaw.com/fullcalendar/
+  [3]: https://foodhackingbase.org/wiki/Events