Skip to content
Browse files

Update formatting to markdown.

  • Loading branch information...
1 parent 5ccade0 commit 964b0e1c479963d895b5858dde71a0c4e612fb41 @jnunemaker committed Apr 20, 2012
Showing with 17 additions and 15 deletions.
  1. +17 −15 README.md
View
32 README.md
@@ -1,31 +1,33 @@
-= adapter-mongo
+# adapter-mongo
Mongo adapter for adapter gem.
- require 'adapter/mongo'
+```ruby
+require 'adapter/mongo'
- client = Mongo::Connection.new.db('adapter')['testing']
- adapter = Adapter[:mongo].new(client)
- adapter.clear
+client = Mongo::Connection.new.db('adapter')['testing']
+adapter = Adapter[:mongo].new(client)
+adapter.clear
- adapter.write('foo', 'bar')
- puts 'Should be bar: ' + adapter.read('foo').inspect
+adapter.write('foo', 'bar')
+puts 'Should be bar: ' + adapter.read('foo').inspect
- adapter.delete('foo')
- puts 'Should be nil: ' + adapter.read('foo').inspect
+adapter.delete('foo')
+puts 'Should be nil: ' + adapter.read('foo').inspect
- adapter.write('foo', 'bar')
- adapter.clear
- puts 'Should be nil: ' + adapter.read('foo').inspect
+adapter.write('foo', 'bar')
+adapter.clear
+puts 'Should be nil: ' + adapter.read('foo').inspect
- puts 'Should be bar: ' + adapter.fetch('foo', 'bar')
+puts 'Should be bar: ' + adapter.fetch('foo', 'bar')
+```
See examples/ or specs/ for more usage.
-== Note on Patches/Pull Requests
+## Contributing
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so we 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 so we can ignore when we pull)
-* Send us a pull request. Bonus points for topic branches.
+* Send us a pull request. Bonus points for topic branches.

0 comments on commit 964b0e1

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