Update documentation and add a changelog

Vaelor · Aug 14, 2017 · d15b7a7 · d15b7a7
1 parent 036e37d
commit d15b7a7
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 3 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -0,0 +1,22 @@
+2.0.0
+'''''
+
+Breaking change for file uploads.
+Instead of a `data` dict containing all formdata,
+a `files` dict is in the following endpoints
+ - emoji
+  - `create_custom_emoji()` takes `emoji_name` additionally to a `files` dict
+ - files
+  - `upload_file()` takes `channel_id` additionally to a `files` dict
+ - brand
+  - `upload_brand_image()`
+ - saml
+  - `upload_idp_certificate()`
+  - `upload_public_certificate()`
+  - `upload_private_key()`
+ - system
+  - `upload_license_file()`
+ - users
+  - `set_user_profile_image()`
+
+See the documentation for an example.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,3 @@
 include README.rst
+include CHANGELOG.rst
 include LICENSE
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1,4 @@
+CHANGELOG
+=========
+
+.. include:: ../CHANGELOG.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,13 +3,15 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to mattermostdriver's documentation!
-============================================
+Mattermostdriver documentation
+==============================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
+   changelog
+
 See https://github.com/Vaelor/python-mattermost-driver for the github repository.
 
 You interact with this module mainly by using the Driver class.