Skip to content

Commit d179a39

Browse files
committed
Update release notes for v1 release
- Mark authentication parameter changes as breaking - Update environment variable changes as breaking - Add summary for v1 preparation Signed-off-by: Mathias L. Baumann <[email protected]>
1 parent 569554e commit d179a39

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

RELEASE_NOTES.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This is the first major version release with authentication parameter updates and dependency version expansion.
66

77
## Upgrading
88

9-
* The `key` parameter in the `Dispatcher` constructor is now deprecated. Use `auth_key` instead. The `sign_secret` parameter is an additional optional parameter for signing.
10-
* The `components` property in `DispatchInfo` is now deprecated. Use `target` instead.
9+
* The `key` parameter in the `Dispatcher` constructor is deprecated. Use `auth_key` instead.
10+
* The `sign_secret` parameter is available and should be used for authentication. It will be soon required.
11+
* The `components` property in `DispatchInfo` is deprecated. Use `target` instead.
1112

1213
## New Features
1314

0 commit comments

Comments
 (0)