Permalink
Browse files

Wrote a README (and switched it to .textile)

  • Loading branch information...
1 parent 809c66c commit dad976b321881657753d50d37bd151b268ab91bd @jeffkreeftmeijer jeffkreeftmeijer committed with shingara Dec 16, 2009
Showing with 27 additions and 5 deletions.
  1. +0 −5 README.md
  2. +27 −0 README.textile
View
@@ -1,5 +0,0 @@
-Machinist adapter for [MongoMapper](http://github.com/jnunemaker/mongomapper).
-
-## TODO
-
-* Spec for EmbeddedDocument.
View
@@ -0,0 +1,27 @@
+h1. MachinistMongomapper
+
+A "Machinist":http://github.com/notahat/machinist adapter for "MongoMapper":http://github.com/jnunemaker/mongomapper.
+
+h2. Usage
+
+Using MachinistMongomapper is simple. Just install the gem;
+
+bc. gem install machinist_mongomapper
+
+And replace the first line of your @blueprints.rb@;
+
+bc. require 'machinist/active_record'
+
+with this;
+
+bc. require 'machinist/mongomapper'
+
+Now you can use Machinist with your Mongo database. Have fun!
+
+h2. Todo
+
+* Write a spec for EmbeddedDocument.
+
+h2. License
+
+Copyright (c) 2009 Yeasty Mobs, released under the MIT license

0 comments on commit dad976b

Please sign in to comment.