change log

Author: SharpBit

CHANGELOG.md

@@ -1,10 +1,28 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [3.0.0]
+### Added
+- Official API support (all endpoints implemented, all methods documented)
+- `Forbidden` error raised when code 403 received
+- New terminology! "BrawlAPI" refers to the [unofficial API](https://api.brawlapi.cf/v1) while "OfficialAPI" refers to the [official API](https://developer.brawlstars.com)
+### Changed (BREAKING)
+- The unofficial API's client will now be accessed as `brawlstats.BrawlAPI` (from `brawlstats.Client`)
+- The unofficial API's models will now be accessed as `brawlstats.brawlapi.ModelName`
+- The official API's client will be accessed by `brawlstats.OfficialAPI`
+- The official API's models will be accessed by `brawlstats.officialapi.ModelName`
+- `get_leaderboard()` will now require "brawlers" for the ranking type and the actual brawler name passed through the brawler kwarg.
+- `get_leaderboard()` `count` argument has been renamed to `limit`
+### Fixed
+- BrawlAPI `get_leaderboard` parameter documentation fixed
+- Arguments passed into functions that require player/club tags now properly get formatted correctly.
+
 ## [2.3.14] - 9/14/19
 ### Changed
-- Default timeout to 30
-- Cache size for the maximum size necessary (3 r/s)
+- Default timeout from 10 to 30
+### Fixed
+- Cache is smaller due to smaller 3 r/s ratelimit (from 5)
+- Fixed a bug where `UnexpectedError` did not work due to a typo.
 
 ## [2.3.13] - 8/29/19
 ### Added

README.rst

@@ -20,16 +20,16 @@ Brawl Stats
     :target: https://github.com/SharpBit/brawlstats/blob/master/LICENSE
     :alt: MIT License
 
-- This library is a sync and async wrapper the unofficial `Brawl Stars API`_.
+- This library is a sync and async wrapper for https://brawlapi.cf (BrawlAPI) and the official Brawl Stars API.
 - Python 3.5.3 or later is required.
-- To keep up with API changes, discussions, and status, I recommend you join the API's `discord server`_.
 
 Features
 ~~~~~~~~
 
-- Covers all of the API endpoints.
+- Covers all of the endpoints of both APIs.
 - Use the same client for sync and async usage.
-- Helper functions to access other game files such as maps and audio files.
+- Choose which API you want to use!
+- Access game constants such as maps, brawlers, and images.
 - Easy to use with an object oriented design.
 
 Installation
@@ -54,40 +54,40 @@ Documentation is being hosted on `Read the Docs`_.
 
 Examples
 ~~~~~~~~
-Examples are in the `examples folder`_.
-
+Examples are in the `examples folder`_. Within each folder, you will find:
 - ``sync.py`` shows you basic sync usage
 - ``async.py`` shows you basic async usage
-- ``discord_cog.py`` shows an example Discord Bot cog using `discord.py rewrite`_
+- ``discord_cog.py`` shows an example Discord Bot cog using `discord.py`_
 
 Misc
 ~~~~
 
-- If you are currently using this wrapper, feel free to star this repository :)
+- If you are currently using this wrapper, please star this repository :)
 - If you come across an issue in the wrapper, please `create an issue`_. Do **not** PM me on Discord for help.
-- If you need an API Key, create one using the `dashboard`_.
+- If you need an API Key for BrawlAPI, create one using the `dashboard`_. If you need one for the official API, visit https://developer.brawlstars.com
+- To receive help for using the BrawlAPI, I recommend you join BrawlAPI's `discord server`_.
 
 Contributing
 ~~~~~~~~~~~~
 Special thanks to this project's contributors ❤️
 
 - `4JR`_
-- `OrangutanGaming`_
-- `Stitch`_
 - `kjkui`_
 - `Kyber`_
 - `Pollen`_
+- `OrangutanGaming`_
+- `Stitch`_
 
 If you want to contribute, whether it be a bug fix or new feature, make sure to follow the `contributing guidelines`_.
 
-.. _Brawl Stars API: https://api.brawlapi.cf/v1
 .. _create an issue: https://github.com/SharpBit/brawlstats/issues
 .. _discord server: https://discord.me/BrawlAPI
 .. _Read the Docs: https://brawlstats.rtfd.io/
 .. _examples folder: https://github.com/SharpBit/brawlstats/tree/master/examples
-.. _discord.py rewrite: https://github.com/rapptz/discord.py/tree/rewrite
+.. _discord.py: https://github.com/rapptz/discord.py
 .. _contributing guidelines: https://github.com/SharpBit/brawlstats/blob/master/CONTRIBUTING.md
 .. _dashboard: https://brawlapi.cf/dashboard
+
 .. _4JR: https://github.com/fourjr
 .. _OrangutanGaming: https://github.com/OrangutanGaming
 .. _Stitch: https://github.com/Soumil07