Skip to content

Commit aa597d2

Browse files
committed
Improve the readme
1 parent 830cd88 commit aa597d2

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
Django Mqueue Livefeed
22
======================
33

4-
Realtime feed and dashboard for monitoring events from multiple sites. This watches events coming from multiple sites
5-
via websockets.
4+
Monitor events coming from multiple sites via websockets
65

76
Dependencies
87
------------
98

109
- [Django Mqueue](https://github.com/synw/django-mqueue): the events queue for Django.
11-
1210
- [Centrifugo](https://github.com/centrifugal/centrifugo): the websockets server.
13-
1411
- [Django Instant](https://github.com/synw/django-instant): the Centrifugo <-> Django layer
1512

1613
Install
1714
-------
1815

1916
``pip install django-mqueue-livefeed``
2017

21-
Add `"mqueue_livefeed",` to INSTALLED_APPS
18+
Add to INSTALLED_APPS:
19+
20+
```
21+
"instant",
22+
"mqueue",
23+
"mqueue_livefeed",
24+
```
2225

2326
In settings.py:
2427

@@ -36,23 +39,24 @@ INSTANT_SUPERUSER_CHANNELS = (
3639
)
3740
```
3841

42+
Note: you can apply the settings above to as much sites as you want to emit their events in the feed. Just create
43+
a site object in the admin for each of the sites to have them in the dashboard.
44+
3945
Set the urls:
4046

4147
```python
4248
url(r'^events/', include('mqueue_livefeed.urls')),
4349
```
4450

45-
Create your monitored sites in the admin.
51+
Create your monitored sites in the admin. And go to `/events/`
4652

4753
Test events
4854
-----------
4955

50-
Go to `/events/'
51-
52-
To generate test events it a management command is available:
56+
To generate test events a management command is available:
5357

5458
```
5559
python3 manage.py feed_mq
5660
```
5761

58-
It will generate 6 sites in the admin and feed them with events
62+
It will generate 6 sites in the admin and feed them with events: run, go to `/events/` and watch

0 commit comments

Comments
 (0)