README.md in mix-rails-0.7.0 vs README.md in mix-rails-0.10.3
- old
+ new
@@ -1,8 +1,8 @@
-# Mix::Rails
+# MixRails
-TODO: Write a gem description
+MixRails is a CMS based on Ruby on Rails and uses Mongoid as ORM(MongoDB).
## Installation
Add this line to your application's Gemfile:
@@ -10,16 +10,28 @@
And then execute:
$ bundle
-Or install it yourself as:
+## Usage
- $ gem install mix-rails
+Create a new rails project.
-## Usage
+ $ rails new myproject -T --skip-active-record --skip-bundle --dummy-path=spec/dummy
-TODO: Write usage instructions here
+In your config/application.rb add these after require 'rails/all'.
+
+```ruby
+require 'mix-rails/all'
+```
+
+Configure a mongoid instance with:
+
+ $ rails generate mongoid:config
+
+And then run the application
+
+ $ bundle exec rails server
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)