diff options
| -rw-r--r-- | README.md | 8 |
1 files changed, 7 insertions, 1 deletions
@@ -6,6 +6,10 @@ Inboxes is a young messaging system for Rails app. It: - read/unread discussions counter - any user can be invited to discussion by the member of this discussion, so you can chat with unlimited number of users +##Upgrading from 0.1 to current version (0.2) + +**Run `rails generate inboxes:upgrade_discussible` and then roll up the migration. Your DB is upgraded!** + ##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). Now the gem is tested only with Ruby 1.8.7 and REE. @@ -14,13 +18,15 @@ We recommend to use Inboxes with [Faye](https://github.com/jcoglan/faye), becaus Remember that unfortunately, Inboxes reserve 3 resources names: Discussion, Message and Speaker. +Since version 0.2.0, it is possible to add `has_inboxes` option to any model. For instance, it can be `Person` or `Teacher`. + ##Installation *Make sure that Devise is already installed and configured in your app!* 1. Add `gem "inboxes", "~> 0.1.2"` to the `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 `has_inboxes` to your User model like [here](https://gist.github.com/1330080) +3. Add `has_inboxes` to your User model like [here](https://gist.github.com/1330080). 4. Now Inboxes are 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 into your app and make anything with them: `rails generate inboxes:views` |