Skip to content

Commit b0f1b32

Browse files
authored
docs(readme): add chat notice (#114)
1 parent f738ee1 commit b0f1b32

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Stream Django
1+
## Stream Django <!-- omit in toc -->
22
[![build](https://github.com/GetStream/stream-django/workflows/build/badge.svg)](https://github.com/GetStream/stream-django/actions) [![PyPI version](https://badge.fury.io/py/stream-django.svg)](http://badge.fury.io/py/stream-django)
33

44
[stream-django](https://github.com/GetStream/stream-django) is a Django client for [Stream](https://getstream.io/), it supports Django from 1.11 up to and including 4.0 using Python 2.7 and 3.4, 3.5, 3.6+.
@@ -7,6 +7,8 @@ You can sign up for a Stream account at https://getstream.io/get_started.
77

88
Note there is also a lower level [Python - Stream integration](https://github.com/getstream/stream-python) library which is suitable for all Python applications.
99

10+
> 💡 This is a library for the **Feeds** product. The Chat SDKs can be found [here](https://getstream.io/chat/docs/).
11+
1012
### Build activity streams & news feeds
1113

1214
<p align="center">
@@ -32,18 +34,30 @@ You can check out our example apps built using this library (you can deploy them
3234
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
3335
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3436

35-
- [What can you build?](#what-can-you-build)
36-
- [Demo](#demo)
37+
- [Build activity streams & news feeds](#build-activity-streams--news-feeds)
38+
- [Example apps](#example-apps)
39+
- [Table of Contents](#table-of-contents)
3740
- [Installation](#installation)
3841
- [Model integration](#model-integration)
42+
- [Activity fields](#activity-fields)
43+
- [Activity extra data](#activity-extra-data)
3944
- [Feed manager](#feed-manager)
45+
- [Feeds bundled with feed_manager](#feeds-bundled-with-feed_manager)
46+
- [User feed:](#user-feed)
47+
- [News feeds:](#news-feeds)
48+
- [Notification feed:](#notification-feed)
49+
- [Follow a feed](#follow-a-feed)
4050
- [Showing the newsfeed](#showing-the-newsfeed)
4151
- [Activity enrichment](#activity-enrichment)
4252
- [Templating](#templating)
4353
- [Settings](#settings)
4454
- [Temporarily disabling the signals](#temporarily-disabling-the-signals)
4555
- [Customizing enrichment](#customizing-enrichment)
46-
- [Low level APIs access](#low-level-apis-access)
56+
- [Enrich extra fields](#enrich-extra-fields)
57+
- [Change how models are retrieved](#change-how-models-are-retrieved)
58+
- [Preload related data](#preload-related-data)
59+
- [Full documentation and Low level APIs access](#full-documentation-and-low-level-apis-access)
60+
- [Copyright and License Information](#copyright-and-license-information)
4761

4862
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
4963

0 commit comments

Comments
 (0)