mongo_mysql_relations 0.0.1 → 0.0.2

data/README.md

@@ -18,7 +18,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+  Add MongoMySqlRelations to your models (both Active record and mongoid)
+
+    class User < ActiveRecord::Base
+      include MongoMysqlRelations
+
+    end
+
+  and mongoid:
+
+    class Picture
+      include Mongoid::Document
+      include MongoMysqlRelations
+    end
+
+ on the mongo side you can use:
+ * to_mysql_belongs_to
+ * to_mysql_has_many
+ * to_mysql_has_one
+
+and on the ActiveRecord side
+
+* from_mysql_belongs_to
+* from_mysql_has_many
+* from_mysql_has_one
+
+you'll need to specify the association class and sometimes the foreign key (in `has_*` associations)
+
+    class Picture
+      include Mongoid::Document
+      include MongoMysqlRelations
+
+      to_mysql_belongs_to :user, :class => User
+    end
+
+    class User < ActiveRecord::Base
+      include MongoMysqlRelations
+
+      from_mysql_has_many :pictures, :class => Picture, :foreign_key => "user_id"
+    end
 
 ## Contributing
 

data/lib/mongo_mysql_relations/version.rb

@@ -1,3 +1,3 @@
 module MongoMysqlRelations
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo_mysql_relations
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: