Permalink
Browse files

README

  • Loading branch information...
1 parent 7394cb5 commit 424adf553ac79f51f2bd4d49bed8d8018d14b896 @winton committed Sep 15, 2011
Showing with 44 additions and 24 deletions.
  1. +44 −24 README.md
View
@@ -1,36 +1,56 @@
-MaitreD
-===========
+Maitre D
+========
-A gem template for new projects.
+A reservation API for deploy environments.
-Requirements
-------------
+Setup
+-----
<pre>
-gem install stencil
+git clone git@github.com:winton/maitre_d.git
+rake gems:install
</pre>
-Setup the template
-------------------
+Now your environment is ready to run `passenger start` on the application (or whatever you use to run Sinatra apps).
-You only have to do this once.
+== /reservations/create
-<pre>
-git clone git@github.com:winton/maitre_d.git
-cd maitre_d
-stencil
-</pre>
+=== Post
-Setup a new project
--------------------
+ { seconds: 3600, environment: 'beta', user: 'me' }
-Do this for every new project.
+=== Response
-<pre>
-mkdir my_project
-git init
-stencil maitre_d
-rake rename
-</pre>
+Returns state of created reservation:
+
+ { status: 'reserved', expires: 1316133837, user: 'me' }
+
+== /reservations/show
+
+=== Post
+
+ { environment: 'beta' }
+
+=== Response
+
+ { status: 'available' }
+
+or
+
+ { status: 'reserved', expires: 1316133837, user: 'me' }
+
+== /reservations/destroy
+
+=== Post
+
+ { environment: 'beta' }
+
+=== Response
+
+Returns state of reservation when you destroyed it:
+
+ { status: 'available' }
+
+or
-The last command does a find-replace (gem\_template -> my\_project) on files and filenames.
+ { status: 'reserved', expires: 1316133837, user: 'me' }

0 comments on commit 424adf5

Please sign in to comment.