Skip to content

Commit

Permalink
Use README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
epandurski committed Nov 21, 2018
1 parent bfafa9a commit d8a15cd
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Flask-SignalBus
===============

**Flask-SignalBus** adds to Flask-SQLAlchemy the capability to
*atomically* send messages (signals) over a message bus.

The processing of each message involves three steps:

1. The message is recorded in the SQL database as a row in a table.

2. The message is sent over the message bus (RabbitMQ for example).

3. Message's corresponding table row is deleted.

Normally, the sending of the recorded messages (steps 2 and 3) is done
automatically after each transaction commit, but when needed, it can
also be triggered explicitly with a method call, or through the Flask
command line interface.


You can read the docs [here](https://flask-signalbus.readthedocs.io/en/latest/).
1 change: 0 additions & 1 deletion README.rst

This file was deleted.

0 comments on commit d8a15cd

Please sign in to comment.