diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 9 insertions, 9 deletions
@@ -8,27 +8,27 @@ Inboxes is a young messaging system for Rails app. It: ##Requirements and recommendations -Inboxes requires Rails 3.x and [Devise](https://github.com/plataformatec/devise) for user identification (surely, messaging system is not possible without users). +Inboxes requires Rails 3.x and [Devise](https://github.com/plataformatec/devise) for user identification (surely, messaging system is not possible without users). Now the gem is tested only with Ruby 1.8.7 and REE. -We recommend to use Inboxes with [Faye](https://github.com/jcoglan/faye), because it's really useful with it. +We recommend to use Inboxes with [Faye](https://github.com/jcoglan/faye), because it's really sexy with it. -Remember that unfortunately, Inboxes reserve 3 model names: Discussion, DiscussionView, Message and Speaker and 2 controller names: Messages and Discussions. +Remember that unfortunately, Inboxes reserve 3 resources names: Discussion, Message and Speaker. ##Installation *Make sure that Devise is already installed and configured!* -1. Add `gem "inboxes", :git => git://github.com/kirs/inboxes.git` to your `Gemfile` and run `bundle install` -2. Run `rails generate inboxes:install`. This command will generate migration for messaging system. Don't forget to run migrations: `rake db:migrate` +1. Add `gem "inboxes"` to your `Gemfile` and run `bundle install` +2. Execute `rails generate inboxes:install`. This command will generate migration for messaging system. Don't forget to run migrations: `rake db:migrate` 3. Add `inboxes` to your User model like [here](https://gist.github.com/1330080) -4. Now Inboxes is ready to use. Open `http://yoursite.dev/discussions` to show discussions list. You can start new one. +4. Now Inboxes is ready to use. Open `http://yoursite.dev/discussions` to see the list of discussions. You can start new one. -Default Inboxes views are ugly, so you can copy it to your app and make anything with them: `rails generate inboxes:views` -If you have problems with installation if gem, you can check [demo app code](https://github.com/kirs/inboxes-app) +Default Inboxes views are ugly, so you can copy into your app and make anything with them: `rails generate inboxes:views` +If you have problems with installation, you can check [code of demo app](https://github.com/kirs/inboxes-app) ## I18n -By default, this gem provides localized phrases for Russian and English languages. You can easily override any of them. [Here is](https://github.com/kirs/inboxes/blob/master/config/locales/en.yml) list of all I18n phrases. +By default, the gem provides localized phrases for Russian and English languages. You can easily override any of them. [Here is](https://github.com/kirs/inboxes/blob/master/config/locales/en.yml) list of all I18n phrases. ##Todo |