Permalink
Browse files

Merge pull request #5 from basho/csm_add_readme

Add README.
  • Loading branch information...
2 parents 1ee7bb8 + 18c1603 commit 54fb80f2f7d5df50dac1c1888ad895b03256c72c @seancribbs seancribbs committed Oct 11, 2012
Showing with 19 additions and 3 deletions.
  1. +19 −3 README.md
  2. BIN screenshot.png
View
@@ -1,4 +1,20 @@
-giddyup
-=======
+# GiddyUp
-The successor to basho_reins
+Welcome to the exciting world of `giddyup`.
+
+## What is GiddyUp?
+
+GiddyUp is the visual scorecard for [riak_test](http://github.com/basho/riak_test). GiddyUp provides two services, seeding ```riak_test``` with the list of tests which should be run for each platform, and receiving tests results and logs via a REST interface.
+
+## Bootstrapping and Configuration
+
+1. Migrate your database using ```bundle exec rake db:migrate```
+2. Seed your database with the default set of tests, platforms and
+ backend combinations using ```bundle exec rake db:seed```
+3. Create a ```.env``` file with the following environment variables:
+ ```DATABASE_URL```, ```S3_AKID```, ```S3_BUCKET``` and ```S3_SECRET```.
+4. Start your application with ```foreman start```
+
+## Screenshot
+
+![Screenshot](https://raw.github.com/basho/giddyup/master/screenshot.png "Screenshot")
View
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 54fb80f

Please sign in to comment.