Update CHANGELOG, README.md

Getting ready for 2.0.0 release. Major verison bump due to broken compatiblity.
heroiclabs · Apr 2, 2020 · 733526f · 733526f
1 parent 91b4685
commit 733526f
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,14 +6,33 @@ The format is based on [keep a changelog](http://keepachangelog.com/) and this p
 ## [Unreleased]
 
 ### Added
+
+### Fixed
+
+## [2.0.0] - 2020-04-02
+
+### Added
+
 - Decode base64 data in `MatchData`. (breaks compat)
+- Add `FacebookInstantGame` endpoints (link/unlink/authenticate).
+- GDScript-style comments (removing all XML tags).
+- Add `list_storage_objects_async` `p_user_id` parameter to allow listing user(s) objects.
 
 ### Fixed
 
 - Fix encoding of `op_code` in `MatchDataSend` and marshalling of `NakamaSocket.send_match_state_[raw_]async`.
 - Fix parsing of `MatchmakerMatched` messages when no token is specified.
 - Disable `HTTPRequest.use_threads` in HTML5 exports.
 - `NakamaSession.is_expired` returned reversed result.
+- Fix `NakamaClient.update_account_async` to allow updating account without username change.
+- Fix `NakamaClient.update_group_async` to allow updating group without name change.
+- Fix `HTTPAdapter._send_async` error catching for some edge cases.
+- Fix `NakamaClient.send_rpc_async` with empty payload (will send empty string now).
+- Fix `NakamaRTAPI.Status` parsing.
+- Fix `NakamaClient` `list_leaderboard_records_around_owner_async` and `list_leaderboard_records_async` parameter order. (breaks compat)
+- Rename `NakamaClient.JoinTournamentAsync` to `join_tournament_async` for consistent naming.
+- Update all `p_limit` parameters default in `NakamaClient` to `10`.
+- Fix `NakamaRTAPI.Stream` parsing.
 
 ## [1.0.0] - 2020-01-28
 ### Added

diff --git a/README.md b/README.md
@@ -140,6 +140,16 @@ cd nakama-godot
 sh test_suite/run_tests.sh
 ```
 
+### Make a new release
+
+To make a new release ready for distribution, simply zip the addons folder recursively (possibly adding `CHANGELOG`, `LICENSE`, and `README.md` too).
+
+On unix systems, you can run the following command (replacing `$VERSION` with the desired version number). Remember to update the `CHANGELOG` file first.
+
+```shell
+zip -r nakama-$VERSION.zip addons/ LICENSE CHANGELOG.md README.md
+```
+
 ### License
 
 This project is licensed under the [Apache-2 License](https://github.com/heroiclabs/nakama-godot/blob/master/LICENSE).