aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKir2011-11-01 11:15:43 +0400
committerKir2011-11-01 11:15:43 +0400
commit54078bc80f3c05a7f2b2b6cb31e2496adb3fe0b1 (patch)
tree8e4ab0d91ea59c1d9b3e347f2f48f1b4ebd2aa23 /README.md
parent48c144ed34e2d5977bb8e5af8a9c7e8dfc253361 (diff)
downloadinboxes-54078bc80f3c05a7f2b2b6cb31e2496adb3fe0b1.tar.bz2
Installation guide in readme and active record extension
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index e7b4fbd..9ecb749 100644
--- a/README.md
+++ b/README.md
@@ -10,4 +10,20 @@ Inboxes is a young messaging system for Rails app. It:
Inboxes requires Rails 3.x and [Devise](https://github.com/plataformatec/devise) for user identification (surely, messaging system is not possible without users).
-We recommend you to use it with [Faye](https://github.com/jcoglan/faye), because it's really very useful with it. \ No newline at end of file
+We recommend to use Inboxes with [Faye](https://github.com/jcoglan/faye), because it's really useful with it.
+
+Remember that unfortunately, Inboxes reserve 3 model names: Discussion, DiscussionView, Message and Speaker and 2 controller names: Messages and Discussions.
+
+#Installation
+
+0. 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`
+3. Add `inboxes` to your User model like [here](https://gist.github.com/1330080)
+4.
+
+##Todo
+
+- add rspec tests
+- move controllers and models to namespace \ No newline at end of file