ActsAsChattable
===============

ActsAsChattable is a plugin which make web chatting easy.

With this plugin, you can add a user-to-user chatting system into your Rails app 
within 3-minutes.


Version:	0.2.0 - beta						     
Author: Yuanyi Zhang -- http://elctech.com
Contributors:	
License:	Ruby MIT						     

==Installation

./script/plugin install https://svn.elctech.com/svn/public/plugins/acts_as_chattable

==Demo

svn co https://svn.elctech.com/svn/public/demo/acts_as_chattable

==Usage

* At first, I assume you have a 'User' model and it own a 'name' method which will
  return user's chatting name. If you don't have these yet, create them and let's 
  go!

1. Install Juggernaut, acts_as_chattable needs Juggernaut to get *PUSH* support.

  script/plugin install svn://rubyforge.org//var/svn/juggernaut/trunk/juggernaut

2. Generate chat_controller.

  script/generate chattable

3. Render chat in views

  <%= render_chat(user, friends) %>
  <%= buddy_list(friends) %>

  user should be current_user which will be used to create a Juggernaut channel.
  friends should be an array of user which presents current user's friends. 

  You can use chat_link(friend) to generate buddy_list customly, it will return a
  link which will open a chat window with this friend.

  More documents are available at: 
  
  http://letrails/plugins/acts_as_chattable

4. At last, Don't forget to start push_server.

  sudo ruby script/push_server
  ruby script/server

* It's done, open your browser and enjoy the chatting.

===================================
All Feedbacks/Comments/Issues are welcome.