From 7625f45a68741b9febd0e11fb1e12559e2320af8 Mon Sep 17 00:00:00 2001 From: barrett Date: Wed, 4 Sep 2024 17:10:28 -0500 Subject: [PATCH] docs(README): update release steps --- README.md | 6 +++++- src/lib.rs | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a742645..01ab488 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,10 @@ There are a few ground rules, though: ### Making a Release -The only note I have for now is to generate the README using `cargo-rdme`. The crate includes a configuration file for this tool, so it should just work. +There are only a few steps to releasing this crate. + +1. Generate the `README.md` file using `cargo-rdme`. +1. Change the version numbers in `/Cargo.toml` and `/macros/Cargo.toml`. +1. Run `cargo publish`! diff --git a/src/lib.rs b/src/lib.rs index c625aa3..7fa3d16 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -42,7 +42,11 @@ There are a few ground rules, though: ### Making a Release -The only note I have for now is to generate the README using `cargo-rdme`. The crate includes a configuration file for this tool, so it should just work. +There are only a few steps to releasing this crate. + +1. Generate the `README.md` file using `cargo-rdme`. +1. Change the version numbers in `/Cargo.toml` and `/macros/Cargo.toml`. +1. Run `cargo publish`! */ #[cfg(doctest)]