Skip to content
Browse files

some readme tweaks

  • Loading branch information...
1 parent bef7093 commit a3a5b3cd5eb40862fdf573b304ed9f8dbd4c6403 Mark Phillips committed Jul 7, 2012
Showing with 6 additions and 2 deletions.
  1. +6 −2 README.md
View
8 README.md
@@ -1,10 +1,14 @@
### Riak Compared To Dynamo
-This is the GitHub home of the Riak and Dynamo comparison.
+This is the GitHub home of the Riak and Dynamo comparison. The comparison lives [here](http://www.themarkphillips.com/riak-and-dynamo/docs/dynamo.html). (**It's about 60% done.**)
### How does this work?
-I hacked a side by side comparison using [Docco](http://jashkenas.github.com/docco/)
+I hacked the side by side comparison using [Docco](http://jashkenas.github.com/docco/).
+* The text for comparison lives in [dynamo.js](/dynamo.js).
+* If you want make the site all pretty, spend some time with [docco.css](/docs/docco.css).
+* To generate the comparison locally, run `docco dynamo.js` and navigate to `dynamo.html` in your favorite browser
+* To update the actual comparison, checkout the `gh-pages`, do a `$ git rm -rf .`, copy the contents of what's in `master` branch, add & commit the changes, and finish with a `$ git push origin gh-pages`.

0 comments on commit a3a5b3c

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