Skip to content
Newer
Older
100644 39 lines (24 sloc) 1.02 KB
e91aff4 @baphled Initial commit
authored
1 = ChatEngine
2
3 ChatEngine is a Rails 3 Engine created to give web applications an easy to use chat system.
4
5 = Aim
6
7 The aim of this project is to make adding a chat engine to a Rails application quick and easy.
8
f7174c3 @baphled Updated documentation
authored
9 = Installation
10
11 gem install chat-engine
12
13 rails g chat_engine:install
14 rails g chat_engine:assets
15
16 ChatEngine uses pusher to handle asychronous messaging. We have added a the necessary initializer for you to easily setup Pusher.
17
18 Locate chat_engine.rb in your initializer folder and change the following to your Pusher credentials.
19
20 Pusher.app_id = 'APP ID'
21 Pusher.key = 'KEY'
22 Pusher.secret = 'PASS'
23
24 You are now ready to go!
25
7674fb1 @baphled Added basic functionality to allow us to send messages
authored
26 = Basic features
27
28 * Users able to select colours for their messages
29 * Asynchronous chat messaging
30
e91aff4 @baphled Initial commit
authored
31 = Future Features
32
33 * Guest users able to add comments
34 * Chat modules can be stacked to enhance the chats functionality
35 * Easy to use admin panel for managing chat functionality
36 * Easy to use admin panel for managing features available to users
37 * Manage multiple chatrooms
38
39 This project rocks and uses MIT-LICENSE.
Something went wrong with that request. Please try again.