Wrote a README (and switched it to .textile)

nmerouze · Dec 16, 2009 · dad976b · dad976b
1 parent 809c66c
commit dad976b
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 5 deletions.
diff --git a/README.md b/README.md
diff --git a/README.textile b/README.textile
@@ -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