documentation is good

pjhyett · pjhyett · commit 50116a7dc729 · 2008-04-28T17:38:10.000-07:00
diff --git a/README b/README
@@ -0,0 +1,25 @@
+GitHub Services
+===============
+
+There are three main pieces to this service:
+1) Sinatra server that handles all of the requests (github-services.rb)
+2) JSON payload containing all of the commit data (the same one you get using the API)
+3) JSON payload containing the service data (username, password, room, etc)
+
+Steps to contributing:
+1) Fork the project
+2) Put your code in alphabetical order based on the request path in github-services.rb
+3) Vendor any external gems your code relies on, and make sure to include it in the requires at the top of github-services.rb
+4) Add documentation to docs/service_name (refer to the others for guidance)
+5) Send us a pull request
+
+If you're interested in setting up an interesting test framework to manage the services, that would also be greatly appreciated.
+
+Bugs can be filed here: http://logicalawesome.lighthouseapp.com/projects/8570-github/tickets
+
+
+Thanks to the following people for making this possible:
+* Blake Mizerany
+* Brandon Keepers
+* Florian Frank
+* John Nunemaker
diff --git a/docs/campfire b/docs/campfire
@@ -0,0 +1,14 @@
+Campfire
+========
+
+payload
+-------
+  refer to docs/github_payload
+
+data
+----
+  - subdomain
+  - email
+  - password
+  - room
+  - ssl
diff --git a/docs/github_payload b/docs/github_payload
diff --git a/docs/irc b/docs/irc
@@ -0,0 +1,12 @@
+IRC
+========
+
+payload
+-------
+  refer to docs/github_payload
+
+data
+----
+  - server
+  - port
+  - room
diff --git a/docs/lighthouse b/docs/lighthouse
@@ -0,0 +1,12 @@
+Lighthouse
+========
+
+payload
+-------
+  refer to docs/github_payload
+
+data
+----
+  - subdomain
+  - project_id
+  - token
diff --git a/docs/twitter b/docs/twitter
@@ -0,0 +1,11 @@
+Twitter
+========
+
+payload
+-------
+  refer to docs/github_payload
+
+data
+----
+  - username
+  - password

-Original file line number
+Diff line change
@@ @@ -0,0 +1,12 @@ @@
 +IRC
 +========
++
 +payload
 +-------
 +  refer to docs/github_payload
++
 +data
 +----
 +  - server
 +  - port
 +  - room