From 8c94f6d1cd0dc2ec46164d13489a44a6722d8346 Mon Sep 17 00:00:00 2001 From: Mario Affonso Date: Tue, 19 Mar 2024 08:29:10 -0400 Subject: [PATCH] Improve readme --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a7d3026..23fdfb6 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ Based on [SemanticVersion] from the standard library and is comparable with and dependencies: short_version: github: mraffonso/short_version + version: ~> 0.1.0 ``` 2. Run `shards install` @@ -176,11 +177,12 @@ Creating a release is three steps: tag a commit (the current one), push the tag The current release workflow is: -* update the version specified in `shard.yml` -* commit with the message "Bump version to x.x.x" -* push to main -* run the release script with no arguments `./script/release` -* confirm release creation +* Update the version specified in `shard.yml` +* Update instances of the version in `README.md` +* Commit with the message "Bump version to x.x.x" +* Push to main +* Run the release script with no arguments `./script/release` +* Confirm release creation And that's it, a release is created.