diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 20 insertions, 3 deletions
@@ -30,11 +30,28 @@ If you have problems with installation, you can check [code of demo app](https:/ 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. +#Integration with Faye + +1. Add `gem "faye"` to your Gemfile and run `bundle install`. Install Faye by [the screencast](http://railscasts.com/episodes/260-messaging-with-faye) +2. Create `messaging.js` in `app/assets/javascripts/` with these lines: + + /* + = require inboxes/faye + */ + +3. Copy or replace 2 views from Inboxes example app to your application: [app/views/inboxes/messages/_form](https://github.com/kirs/inboxes-app/blob/master/app/views/inboxes/messages/_form.html.haml) and [app/views/inboxes/messages/create](https://github.com/kirs/inboxes-app/blob/master/app/views/inboxes/messages/create.js.erb) + +4. Add config parameters to your application config (last 2 are not necessary): + + config.inboxes.faye_enabled = true + config.inboxes.faye_host = "inboxes-app.dev" # localhost by default + config.inboxes.faye_port = 9292 # 9292 by default + +5. Faye installation is finished. If you have any troubles, check the [example app](https://github.com/kirs/inboxes-app/) + ##Todo -- Add rspec tests -- Move gem resources to namespace -- Describe integration with Faye +- Add RSpec tests ##Authors |