From 1a9269138f793d0b753f743c7aad9063225ff4df Mon Sep 17 00:00:00 2001 From: Ahmed Ishtiaque Date: Mon, 27 May 2019 02:20:35 -0400 Subject: [PATCH] Minor updates to ReadMe --- README.rst | 19 +++++++------------ docs/source/index.rst | 7 ++----- 2 files changed, 9 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index 47ba296..9d2ec96 100644 --- a/README.rst +++ b/README.rst @@ -10,21 +10,20 @@ Django Chatter .. image:: https://pepy.tech/badge/django-chatter/month :target: https://pypi.org/project/django-chatter/ -Django-based Chat app that supports group chat and real-time updates. +Re-usable Django chat application for Django developers. --------------------------------------------------------------------- -Full docs here: `Chatter Docs `_ +Full docs here: `Django Chatter Docs `_ Chat is a crucial aspect of many web apps at present. However, Django's package repository does not have well-maintained reusable chat packages that Django developers can integrate into their platforms. -Chatter is an attempt to change that. This is an open-source fully reusable chat +Django Chatter is an attempt to change that. This is an open-source fully reusable chat application that has mechanisms to support group chats in place. -The default templates for this app are made with Bootstrap, one of the most -popular CSS frameworks out there. This makes it easier for developers to change -the templates just by modifying the right CSS files. +The HTML front-end for this app is built with Flexbox, making it responsive to +numerous viewports. [More work to be done] Added to that, it can also possibly be used as a REST API, since all the views generate standard JSON responses that need to be parsed by the @@ -33,14 +32,11 @@ websockets present in the front-end of the app using this package. This app makes use of `Django Channels 2 `_ and uses `Redis `_ as the message broker. -**This app is still in its alpha phase. We plan to improve it so it can be used -as a package in other Django-based web apps. ** - -To run chatter properly, you'll require `python>=3.5` and Redis. **Note:** +To run Django Chatter properly, you'll require `python>=3.5` and Redis. **Note:** For development, we are currently using `redis-5.0.3`, built from source on Ubuntu machines. -The core mechanisms of Chatter follows the instructions provided in the +The core mechanisms of Chatter follow the instructions provided in the `Django Channels `_ tutorial section, with some added modifications and theming. @@ -202,4 +198,3 @@ Running list of features to add * Add a "Create Group" option for users on the templates * Add 'Seen by user x' functionality -* Add displaying time with messages diff --git a/docs/source/index.rst b/docs/source/index.rst index 2d285fd..5c3e74b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,7 +2,7 @@ Welcome to Django Chatter's documentation! ========================================== -**Django-based Chat app that supports group chat and real-time updates.** +**Re-usable Django chat application for Django developers.** Chat is a crucial aspect of many web apps at present. However, Django's package repository does not have well-maintained reusable chat packages that Django @@ -11,7 +11,7 @@ developers can integrate into their platforms. Django Chatter is an attempt to change that. This is an open-source fully reusable chat application that has mechanisms to support group chats in place. -the HTML front-end for this app is built with Flexbox, making it responsive to +The HTML front-end for this app is built with Flexbox, making it responsive to numerous viewports. [More work to be done] Added to that, it can also possibly be used as a REST API, @@ -29,9 +29,6 @@ The core mechanisms of Chatter follows the instructions provided in the `Django Channels Tutorial `_ section, with some added modifications and a little theming. -**This app is still in its alpha phase.We plan to improve it so -it can be used as a package in other Django-based web apps.** - Contents --------