Merge pull request #19 from AllSpiceIO/su/new-release

Add changelog and note on versioning with v2

CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+## v2.0.0
+
+This is a breaking change. You will need to update your scripts to use py-allspice v2.
+
+- Renamed Gitea across py-allspice to AllSpice. For example,
+
+    ```py
+    from gitea import Gitea
+
+    gitea = Gitea(URL, TOKEN)
+    ```
+
+    to
+
+    ```py
+    from allspice import AllSpice
+
+    allspice_client = AllSpice(token_text=TOKEN)
+    ```
+
+- Added example scripts in [the examples directory](./examples).
+- Added functions to get AllSpice generated svg and json for CAD files.
+- Added optional Rate Limiting to the client. By default, Rate Limiting is on at 100
+  requests every minute. You can disable it by setting `ratelimiting` to `None` when
+  creating an instance of `AllSpice`.
+- Added `units_map` argument when creating a new team.

README.md

@@ -82,6 +82,13 @@ for team in teams:
 
 Use ``pip install py-allspice`` to install.
 
+## A Note on Versioning
+
+This repository does not follow the same versioning policy as py-gitea. After v1.17.x,
+py-allspice switched to Semantic Versioning with v2.0.0. In general, versions of
+py-allspice do NOT conform to versions of AllSpice Hub, and the latest version of
+py-allspice should be compatible with the current version of AllSpice Hub.
+
 ## Tests
 
 Tests can be run with: