Skip to content

Commit

Permalink
chore: release v4
Browse files Browse the repository at this point in the history
  • Loading branch information
kxxt committed Mar 4, 2023
1 parent 2cfe5fa commit 8752d64
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 2 deletions.
33 changes: 33 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,38 @@
# aspeak Changelog

# v4.0.0

aspeak has been rewritten in Rust!:tada: This is a major release and there are some breaking changes.
Please read the documentation carefully if you are upgrading from v3.x.

Fixes:

- In some cases, the old aspeak can't play audio on some linux platforms.
- aspeak now respects the encoding arg for both stdin and file.
- Stricter validations for command line options.
- Do not overwrite existing file unless --overwrite is specified.

New features:

- Now you can use profiles to save your options.
- For example, you can specify your native locale in your profile so that you don't need to specify it every time.
- You can learn more about profiles in the [documentation](https://github.com/kxxt/aspeak/tree/main#documentation).
- Theoretically, aspeak is now available on more platforms. But I will only publish binaries for Windows, macOS and Linux.
- However, you can still compile aspeak from source on other platforms.
- Now you can use custom endpoints and authentication tokens.
- Now you can add custom request headers.
- More user friendly output and error messages
- Now I have set up GitHub Actions to build and publish automatically.
- Now you can use aspeak as a library in your Rust projects.
- You can learn more about the Rust API at [docs.rs](https://docs.rs/aspeak/).

Changes:

- RIIR
- We no longer publish linux wheels to PyPI because of manylinux compatibility issues. Please compile from source if you want to use python bindings on linux.
- The python bindings has been changed dramatically. Please read the documentation carefully if you are upgrading from v3.x.
- The `-F/--format` option now takes kebab case values(e.g. `audio-16khz-128kbitrate-mono-mp3`) instead of pascal case values.

# v4.0.0-rc.1

- Update docs.
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "aspeak"
version = "4.0.0-rc.1"
version = "4.0.0"
edition = "2021"
authors = ["kxxt <[email protected]>"]
description = "A simple text-to-speech client for Azure TTS API."
Expand Down

0 comments on commit 8752d64

Please sign in to comment.