Permalink
Browse files

Update readme to use markdown

  • Loading branch information...
1 parent acf32b5 commit d49af16d8a8e96163662553b9e55b6badd95674c @jnunemaker committed Apr 20, 2012
Showing with 8 additions and 6 deletions.
  1. +8 −6 README.md
View
@@ -1,12 +1,14 @@
-= Toystore Mongo
+# Toystore Mongo
Mongo integration for Toystore.
-== Install
+## Install
- $ gem install toystore-mongo
+```
+gem install toystore-mongo
+```
-== Usage
+## Usage
class User
include Toy::Mongo
@@ -23,14 +25,14 @@ Including Toy::Mongo includes Toy::Store and then does a few things:
* Overrides get_multi so that it performs one query instead of one query per id
* Adds instance method atomic_update_attributes for persisting only the changes (see #persistable_changes)
-== Note on Patches/Pull Requests
+## Contributing
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a future version unintentionally.
* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
-== Copyright
+## Copyright
See LICENSE for details.

0 comments on commit d49af16

Please sign in to comment.