diff options
| -rw-r--r-- | README.md | 20 |
1 files changed, 11 insertions, 9 deletions
@@ -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 |