Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

README updated, LICENCE added

  • Loading branch information...
commit e3a69fc3b12e4c6ff8aed2c01956967cbb973c05 1 parent ea78582
Philipp Wassibauer authored
Showing with 29 additions and 11 deletions.
  1. +19 −0 LICENSE.txt
  2. +10 −11 README.rst
View
19 LICENSE.txt
@@ -0,0 +1,19 @@
+Copyright (c) 2011 Philipp Wassibauer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
21 README.rst
@@ -1,13 +1,13 @@
-===================
+===============
Django-Threaded-Messages
-===================
+===============
This app is very similar to the Messaging System on Facebook.
There are tests, but they are from the project I forked it from. I will update and improve them once I get around to it.
Features
-============
+===============
* Each Message is a thread with participants and messages
* Inbox with filter for read and unread messages
* Outbox
@@ -21,24 +21,23 @@ Features
User Search
-============
+===============
The app comes with a very basic user search component. If you want to extend it or adapt it to your needs
look at views.recipient_search. Adapt your own version in a seperate app and then
-change the call in your compose templates:
-
-$("#id_recipient").tokenInput("{% url recipient_search %}?format=json", parameters)
+change the call in your compose templates::
+ $("#id_recipient").tokenInput("{% url recipient_search %}?format=json", parameters)
to point to your custom view.
Dependencies
-============
+===============
* Haystack
* Django-notification
Install
-============
+===============
pip install -e http://github.com/philippWassibauer/django-threaded-messages.git#egg=threaded-messages
or
@@ -47,7 +46,7 @@ pip install django-threaded-messages
Similar Projects
-============
+===============
There are two other repositories doing this (one of them is not maintained anymore):
@@ -57,7 +56,7 @@ I am not sure what the exact differences are to this implementation. I am pretty
Follow Me
-============
+===============
http://github.com/philippWassibauer
http://twitter.com/scalar
http://philippw.tumblr.com
Please sign in to comment.
Something went wrong with that request. Please try again.