matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Point to the docs in the README and clear up notes on breaking changes

Browse Source
This commit is contained in:
Rapptz 2015-11-30 20:24:17 -05:00
parent 56a71e3166
commit 5a666c3f0d
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -6,7 +6,17 @@
discord.py is an API wrapper for Discord written in Python.
This was written to allow easier writing of bots or chat logs.
This was written to allow easier writing of bots or chat logs. Make sure to familiarise yourself with the API using the [documentation][doc].
[doc]: http://rapptz.github.io/discord.py/
### Breaking Changes
The discord API is constantly changing and the wrapper API is as well. There will be no effort to keep backwards compatibility in versions before `v1.0.0`.
I recommend that you follow the discussion in the [unofficial Discord API discord channel][ch] and update your installation periodically through `pip install --upgrade discord.py`. I will attempt to make note of breaking changes in the API channel.
[ch]: https://discord.gg/0SBTUU1wZTUzBx2q
## Installing
@ -26,14 +36,6 @@ pip install git+https://github.com/Rapptz/discord.py@develop
Note that this requires `git` to be installed.
### This module is alpha!
The discord API is constantly changing and the wrapper API is as well. There will be no effort to keep backwards compatibility.
I recommend that you follow the discussion in the [unofficial Discord API discord channel][ch] and update your installation periodically through `pip install --upgrade discord.py`.
[ch]: https://discord.gg/0SBTUU1wZTUzBx2q
## Quick Example
```py