Browse files

readme

  • Loading branch information...
1 parent 376ed0c commit 3faebeed69a0515b530aec3959037e44bbfe011c @dhruvbansal dhruvbansal committed Aug 31, 2012
Showing with 38 additions and 2 deletions.
  1. +38 −2 README.rdoc
View
40 README.rdoc
@@ -1,10 +1,46 @@
-= Installation & Running
+= Setup
+
+== Installation
$ git clone https://github.com/infochimps/chiat_day_innovation_matcher.git
$ cd chiat_day_innovation_matcher
$ bundle install
- $ RACK_ENV=development ruby innovation_matcher.rb
+== Configuration
+
+There are two configuration files this app depends upon.
+
+The <tt>settings.yml</tt> file points at the MySQL database so provide
+an appropriate host and credentials. Copy it from the given example:
+
+ $ cp settings.example.yml settings.yml
+
+The <tt>unicorn-conf.rb</tt> file is required if you want to run the
+app behind the Unicorn webserver.
+
+ $ cp unicorn-conf.example.rb unicorn-conf.example.rb
+
+Here you can define where the app will log, leave its pids, and how it
+listens. You can also define the number of worker processes you want
+to run.
+
+== Running
+
+You can run the app locally on port 4567 by just running it with Ruby:
+
+ $ ruby innovation_matcher.rb
+ == Sinatra/1.3.3 has taken the stage on 4567 for development with backup from Thin
+ >> Thin web server (v1.3.1 codename Triple Espresso)
+ >> Maximum connections set to 1024
+ >> Listening on 0.0.0.0:4567, CTRL+C to stop
+
+You can also run it with Unicorn
+
+ $ unicorn -c unicorn-conf.rb
+
+which is what you should do in production, after you've tweaked the
+<tt>unicorn-conf.rb</tt> file.
+
= Usage
== Create a match

0 comments on commit 3faebee

Please sign in to comment.