Skip to content
Browse files

readme.

  • Loading branch information...
1 parent 0a297cd commit 7ff9ee44d338a7fa7a1d14aa17c6090ec1757b1e @dhruvbansal dhruvbansal committed Aug 30, 2012
Showing with 12 additions and 2 deletions.
  1. +12 −2 README.rdoc
View
14 README.rdoc
@@ -7,7 +7,13 @@
= Usage
-Create a match
+== Create a match
+
+Returns an array of innovations matching given parameters +dob+ and
++hometown+. Also returns a +match_id+ that can be used to retrieve
+this match later.
+
+Example:
$ curl -s -X POST http://localhost:4567/matches -d '{"dob": "1983-05-23", "hometown": "New York, NY"}'
{
@@ -22,7 +28,11 @@ Create a match
"innovation_date": "8/14/1877"
...
-Retrieve a created match using a given +match_id+
+== Retrieve a match
+
+Returns an array of innovations from a previously returned +match_id+.
+
+Example:
$ curl -s -X GET http://localhost:4567/matches/6b73f010-d469-012f-ad21-002219342852
{

0 comments on commit 7ff9ee4

Please sign in to comment.
Something went wrong with that request. Please try again.