Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update README with release process and crates.io links #40

Merged
merged 1 commit into from
Sep 25, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,16 @@ APIs are subject to change, and functionality may not be fully implemented.

## Releasing

Releases are currently done using `cargo-release`:

```bash
# to release an alpha version:
$ cargo release --no-publish --dev-version alpha -x --sign --workspace
```
Releases are made using `release-plz`: a PR should be automatically created for each release, and merging will perform the release and publish automatically.

## License

Dual-licensed to be compatible with the Rust project.
Licensed under the Apache License, Version 2.0 `<http://www.apache.org/licenses/LICENSE-2.0>` or the MIT license `<http://opensource.org/licenses/MIT>`, at your option.

[`augurs-core`]: crates/augurs-core
[`augurs-ets`]: crates/augurs-ets
[`augurs-mstl`]: crates/augurs-mstl
[`augurs-js`]: crates/augurs-js
[`augurs-testing`]: crates/augurs-testing
[`pyaugurs`]: crates/pyaugurs
[`augurs-core`]: https://crates.io/crates/augurs-core
[`augurs-ets`]: https://crates.io/crates/augurs-ets
[`augurs-mstl`]: https://crates.io/crates/augurs-mstl
[`augurs-js`]: https://crates.io/crates/augurs-js
[`augurs-testing`]: https://crates.io/crates/augurs-testing
[`pyaugurs`]: https://crates.io/crates/pyaugurs
Loading