Skip to content

Commit

Permalink
Minor updates to ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
ishtiaque06 committed May 27, 2019
1 parent e5215a2 commit 1a92691
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 17 deletions.
19 changes: 7 additions & 12 deletions README.rst
Expand Up @@ -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 <https://django-chatter.readthedocs.io>`_
Full docs here: `Django Chatter Docs <https://django-chatter.readthedocs.io>`_

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
Expand All @@ -33,14 +32,11 @@ websockets present in the front-end of the app using this package.
This app makes use of `Django Channels 2 <http://channels.readthedocs.io>`_ and uses
`Redis <https://redis.io/>`_ 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 <https://channels.readthedocs.io/en/latest/>`_ tutorial section,
with some added modifications and theming.

Expand Down Expand Up @@ -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
7 changes: 2 additions & 5 deletions docs/source/index.rst
Expand Up @@ -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
Expand All @@ -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,
Expand All @@ -29,9 +29,6 @@ The core mechanisms of Chatter follows the instructions provided in the
`Django Channels Tutorial <https://channels.readthedocs.io/en/latest/tutorial/index.html>`_
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
--------
Expand Down

0 comments on commit 1a92691

Please sign in to comment.