From: Greg Brockman <gdb@mit.edu>
Date: Wed, 24 Mar 2010 00:18:29 +0000 (-0400)
Subject: Added some documentation about zcommit
X-Git-Url: http://andersk.mit.edu/gitweb/zcommit.git/commitdiff_plain/2a5885f594eac6d19a2b4085bfb810e79f7aadc4

Added some documentation about zcommit
---

diff --git a/zcommit.py b/zcommit.py
index e56aedb..18f8d4d 100755
--- a/zcommit.py
+++ b/zcommit.py
@@ -41,7 +41,36 @@ class Application(object):
     @cherrypy.expose
     def index(self):
         logger.debug('Hello world app reached')
-        return 'Hello world!'
+        return """
+<p> <i>Welcome to zcommit.</i> </p>
+
+<p> zcommit allows you to send zephyr notifications by sending an HTTP
+POST request to a URL.  Currently zcommit supports POST-backs from
+github.  If you would like it to support another form of POST-back,
+please let us know (zcommit@mit.edu). </p>
+
+<h1> URL structure </h1>
+
+The URL you post to is structured as follows:
+<tt>http://zcommit.mit.edu/$type/$key1/$value1/$key2/$value2/...</tt>.
+So for example, the URL
+<tt>http://zcommit.mit.edu/github/class/zcommit/instance/commit</tt>
+is parsed as having type <tt>github</tt>, class <tt>zcommit</tt>, and
+instance <tt>commit</tt>.  Using this information, zcommit figures out
+how to form a useful message which is then sends as a zephyr.
+
+<h1> Github </h1>
+
+Set your POST-back URL to
+<tt>http://zcommit.mit.edu/github/class/$classname</tt>, followed by
+any of the following optional key/value parameters:
+
+<ul>
+<li> <tt>/instance/$instance</tt> </li>
+<li> <tt>/zsig/$zsig</tt> </li>
+<li> <tt>/sender/$sender</tt> </li>
+</ul>
+"""
 
     class Github(object):
         @cherrypy.expose