aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKir2011-10-31 16:16:45 +0400
committerKir2011-10-31 16:16:45 +0400
commit7a540a454e4b2c2ccac5f6e542fe5130dbd05c8f (patch)
treeddab265d7f62493f0e84a3b7cfbef06b2112123d /README.md
parenta99eda077cd84e42bb526ffecc4bc59c4c1929de (diff)
downloadinboxes-7a540a454e4b2c2ccac5f6e542fe5130dbd05c8f.tar.bz2
Readme and initial changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..46bbce6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+#Inboxes
+
+Inboxes is a young messaging system for Rails app. It:
+- provides 3 models for developers: Discussion, Message and Speaker
+- 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
+
+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