Skip to content

docs(readme): add chat notice #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2022
Merged

docs(readme): add chat notice #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Stream Django
## Stream Django <!-- omit in toc -->
[![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)

[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+.
Expand All @@ -7,6 +7,8 @@ You can sign up for a Stream account at https://getstream.io/get_started.

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

> 💡 This is a library for the **Feeds** product. The Chat SDKs can be found [here](https://getstream.io/chat/docs/).

### Build activity streams & news feeds

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

- [What can you build?](#what-can-you-build)
- [Demo](#demo)
- [Build activity streams & news feeds](#build-activity-streams--news-feeds)
- [Example apps](#example-apps)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Model integration](#model-integration)
- [Activity fields](#activity-fields)
- [Activity extra data](#activity-extra-data)
- [Feed manager](#feed-manager)
- [Feeds bundled with feed_manager](#feeds-bundled-with-feed_manager)
- [User feed:](#user-feed)
- [News feeds:](#news-feeds)
- [Notification feed:](#notification-feed)
- [Follow a feed](#follow-a-feed)
- [Showing the newsfeed](#showing-the-newsfeed)
- [Activity enrichment](#activity-enrichment)
- [Templating](#templating)
- [Settings](#settings)
- [Temporarily disabling the signals](#temporarily-disabling-the-signals)
- [Customizing enrichment](#customizing-enrichment)
- [Low level APIs access](#low-level-apis-access)
- [Enrich extra fields](#enrich-extra-fields)
- [Change how models are retrieved](#change-how-models-are-retrieved)
- [Preload related data](#preload-related-data)
- [Full documentation and Low level APIs access](#full-documentation-and-low-level-apis-access)
- [Copyright and License Information](#copyright-and-license-information)

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

Expand Down