From ed81319e6b78a8196cf7c30cc3b9884a2f2b64d0 Mon Sep 17 00:00:00 2001 From: Ben Sully Date: Mon, 25 Sep 2023 09:34:40 +0100 Subject: [PATCH] chore: update README with release process and crates.io links --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 77389eee..6f6fdec7 100644 --- a/README.md +++ b/README.md @@ -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 `` or the MIT license ``, 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