Permalink
Browse files

README File

We're adding the README file which shows on the Github repo and explains what this
is and how to make it work.
  • Loading branch information...
1 parent 04b27f1 commit c8cba521bbdbf338c5a839e59f4396a0afc281bb @caleywoods committed Sep 1, 2011
Showing with 38 additions and 0 deletions.
  1. +38 −0 README.md
View
@@ -0,0 +1,38 @@
+What Is This?
+-------------
+
+This code shows how use [Twilio](http://twilio.com/) with
+[Sinatra](http://sinatrarb.com) on [DotCloud](http://www.dotcloud.com/).
+
+Sinatra provides a clean, classy DSL for doing simple applications and
+Twilio provides an __AWESOME__ REST API for doing cloud telephony. This
+demo just scratches the surface of what you can do with Twilio (and
+DotCloud really).
+
+To run this code on DotCloud, you need to [get a DotCloud
+account](https://www.dotcloud.com/accounts/register/). DotCloud has a
+free tier, so you won't even need to draw your wallet!
+
+Then clone this repository:
+
+ $ git clone git://github.com/caleywoods/cloudsinger.git
+
+And push it to DotCloud:
+
+ $ cd cloudsinger
+ $ dotcloud push cloudsinger
+
+Happy hacking! Remember: each time you modify something, you need to
+git add + git commit your changes before doing `dotcloud push`.
+
+How Does It Work?
+-----------------
+If you want to see how this sample app was built, we invite you to:
+
+* see the big picture with GitHub's awesome [compare view](https://github.com/caleywoods/cloudsinger/compare/begin...end) --
+ click on each individual commit to see detailed explanations for each step
+* if you prefer text mode (or offline inspection), fallback on
+ `git log --patch --reverse`
+* dive into [DotCloud documentation](http://docs.dotcloud.com/), especially
+ the one for the [Ruby service](http://docs.dotcloud.com/services/ruby/)
+ which is used by this app.

0 comments on commit c8cba52

Please sign in to comment.