Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rudyryk committed Oct 7, 2015
1 parent b1791bc commit 27b5e3a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
**Bachata** is a simple chats engine and toolkit on top of [asyncio](https://docs.python.org/3.4/library/asyncio.html) and [Tornado](http://www.tornadoweb.org/en/stable/).
**Bachata** is a chat server toolkit on top of [asyncio](https://docs.python.org/3.4/library/asyncio.html) and [Tornado](http://www.tornadoweb.org/en/stable/).

- Requires Python 3.3+
- Requires Tornado running on asyncio event loop
- Implements simple messages queue on Redis LPUSH / BRPOP
- Implements reliable messages delivery on Redis BRPOPLPUSH pattern
- Uses WebSockets for messages transport
- Uses JSON messages format
- Simple layer for custom messages routing

Install
=======

```
pip install bachata
```

Documentation
=============

<http://bachata.readthedocs.org/en/latest/>

Example
=======

See basic working example in the [./example](./example) dir.
3 changes: 1 addition & 2 deletions bachata/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
"""**Bachata** is a simple chats engine and toolkit on top
of `asyncio`_ and `Tornado`_.
"""**Bachata** is a chat server toolkit on top of `asyncio`_ and `Tornado`_.
.. _Tornado: http://www.tornadoweb.org/en/stable/
.. _asyncio: https://docs.python.org/3.4/library/asyncio.html
Expand Down

0 comments on commit 27b5e3a

Please sign in to comment.