diff options
| author | Kir | 2011-11-01 11:29:22 +0400 |
|---|---|---|
| committer | Kir | 2011-11-01 11:29:22 +0400 |
| commit | f96948724a0c157f98b952e6bd83da28d06ba1d9 (patch) | |
| tree | 2b14a87f1f77c1e6e8274a18702a190fa0440e90 | |
| parent | 54078bc80f3c05a7f2b2b6cb31e2496adb3fe0b1 (diff) | |
| download | inboxes-f96948724a0c157f98b952e6bd83da28d06ba1d9.tar.bz2 | |
Installation guide in readme and active record extension
| -rw-r--r-- | README.md | 24 |
1 files changed, 16 insertions, 8 deletions
@@ -6,7 +6,7 @@ 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 -#Requirements and recommendations +##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). @@ -14,16 +14,24 @@ We recommend to use Inboxes with [Faye](https://github.com/jcoglan/faye), becaus Remember that unfortunately, Inboxes reserve 3 model names: Discussion, DiscussionView, Message and Speaker and 2 controller names: Messages and Discussions. -#Installation +##Installation -0. Make sure that Devise is already installed and configured. +*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. Then run `rake db:migrate` +2. Run `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. +4. Now Inboxes is ready to use. Open `http://yoursite.dev/discussions` to show discussions list. You can start new one. -##Todo +Default Inboxes views are ugly, so you can copy it to your app and make anything with them: `rails generate inboxes:views` -- add rspec tests -- move controllers and models to namespace
\ No newline at end of file +###Todo + +- Add rspec tests +- Move gem resources to namespace + +###Authors: + +- [Kir Shatrov](https://github.com/kirs/) (Evrone Company) + +##Feel free for pull requests!
\ No newline at end of file |