README

   1 Welcome to zcommit.
   2
   3 zcommit allows you to send zephyr notifications by sending an HTTP
   4 POST request to a URL. Currently zcommit supports POST-backs from
   5 github. If you would like it to support another form of POST-back,
   6 please let us know (zcommit@mit.edu).
   7
   8 == URL structure ==
   9
  10 The URL you post to is structured as follows:
  11 http://zcommit.mit.edu/$type/$key1/$value1/$key2/$value2/.... So for
  12 example, the URL
  13 http://zcommit.mit.edu/github/class/zcommit/instance/commit is parsed
  14 as having type github, class zcommit, and instance commit. Using this
  15 information, zcommit figures out how to form a useful message which is
  16 then sends as a zephyr.
  17
  18 == Types ==
  19
  20 ==== Github ====
  21
  22 Set your POST-back URL to
  23 http://zcommit.mit.edu/github/class/$classname, followed by any of the
  24 following optional key/value parameters:
  25
  26     * /instance/$instance
  27     * /zsig/$zsig
  28     * /sender/$sender
  29