Skip to content

Commit

Permalink
docs: update README.md and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
kxxt committed Mar 25, 2023
1 parent 55a7b31 commit 969b211
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# aspeak Changelog

# v4.2.0

- Show detailed error message in python bindings.
- Fix: Previously, the `role` field in the default profile template is not commented out and set to `Boy`.
You might want to comment it out if you are already using the default profile template and haven't changed it.
- The `role`, `style` and `style_degree` fields are now commented out in the default profile template.
- Feature: Now you can use `--no-rich-ssml` flag to disable rich SSML features such as `role`, `style` and `style_degree`.
This is useful if you are using an endpoint that does not support rich SSML features.
- Fix(Python bindings): Now the `SpeechService` constructor correctly takes an iterable instead of an iterator for `headers` keyword argument.
- Fix: Now aspeak correctly handles endpoint urls that contain query parameters.

# v4.1.0

- You can now use your azure subscription key to authenticate. Special thanks to [@yhmickey](https://github.com/yhmickey)
Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,19 +98,16 @@ Run `aspeak help <subcommand>` to see the help message of a subcommand.

The authentication options should be placed before any subcommand.

For example, to utilize your authentication token and
For example, to utilize your subscription key and
an official endpoint designated by a region,
run the following command:

```sh
$ aspeak --region <YOUR_REGION> --token <YOUR_AUTH_TOKEN> text "Hello World"
$ aspeak --region <YOUR_REGION> --key <YOUR_SUBSCRIPTION_KEY> text "Hello World"
```

If you are using a custom endpoint, you can use the `--endpoint` option instead of `--region`.

In the future, authentication by azure subscription key will be supported.
For now, I don't have a subscription key to test.

To avoid repetition, you can store your authentication details
in your aspeak profile.
Read the following section for more details.
Expand Down

0 comments on commit 969b211

Please sign in to comment.