From 346d666609bd96c9b5f71063ef0a087131f320b5 Mon Sep 17 00:00:00 2001
From: nicomiguelino <nicomiguelino2014@gmail.com>
Date: Mon, 20 Oct 2025 11:37:42 -0700
Subject: [PATCH 1/2] docs: improve release process documentation

- Add Semantic Versioning reference
- Clarify version update steps
- Document Cargo.lock update requirement
- Specify commit message formats
---
 README.md | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 4ba6d28..720d7f1 100644
--- a/README.md
+++ b/README.md
@@ -106,7 +106,21 @@ $ mv signature.rs src/pb_signature.rs
 
 ## Release Process
 
-- Merge PRs into `master`.
-- Update version in `Cargo.toml`, `action.yml`, `Dockerfile`, and GitHub Actions configurations.
-- Create release branch (e.g., `release-1.0.0`) and tag (e.g., `v1.0.0`).
-- Update [Homebrew repo](https://github.com/Screenly/homebrew-screenly-cli) with the latest version.
+This project follows [Semantic Versioning](https://semver.org/) (M.m.p = Major.minor.patch).
+
+1. **Prepare the release:**
+   - Create a release branch (e.g., `release-M.m.p`, like `release-1.0.6`)
+   - Update version in `Cargo.toml`, `action.yml`, and `Dockerfile`
+   - Run `cargo build` to update `Cargo.lock` with the new version
+   - Commit changes with format: `vM.m.p` for the version update, and `chore: bump CLI version in Cargo.lock` for the lockfile
+
+2. **Create and merge the pull request:**
+   - Create a pull request from the release branch to `master`
+   - Once approved and merged, the tag will be pushed automatically
+
+3. **Create the GitHub release:**
+   - The CI/CD pipeline will detect the version tag and create the release automatically
+   - Add the release notes to the GitHub release description
+
+4. **Update Homebrew:**
+   - Update the [Homebrew repo](https://github.com/Screenly/homebrew-screenly-cli) with the latest version

From cbaad9ca84d6cc2ebc3cc49ecc18afe65ba23f54 Mon Sep 17 00:00:00 2001
From: nicomiguelino <nicomiguelino2014@gmail.com>
Date: Mon, 20 Oct 2025 12:32:02 -0700
Subject: [PATCH 2/2] docs: update release process instructions

- Clarify that release branch naming is a suggestion
- Make cargo build step optional
- Add explicit steps for creating and pushing version tags
- Simplify formatting for better readability
---
 README.md | 21 +++++++++++++--------
 1 file changed, 13 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 720d7f1..ef6e0e8 100644
--- a/README.md
+++ b/README.md
@@ -109,18 +109,23 @@ $ mv signature.rs src/pb_signature.rs
 This project follows [Semantic Versioning](https://semver.org/) (M.m.p = Major.minor.patch).
 
 1. **Prepare the release:**
-   - Create a release branch (e.g., `release-M.m.p`, like `release-1.0.6`)
-   - Update version in `Cargo.toml`, `action.yml`, and `Dockerfile`
-   - Run `cargo build` to update `Cargo.lock` with the new version
-   - Commit changes with format: `vM.m.p` for the version update, and `chore: bump CLI version in Cargo.lock` for the lockfile
+  - Create a release branch (e.g., `release-M.m.p`, like `release-1.0.6`). This is just a suggestion; you can name the branch as you prefer.
+  - Update version in `Cargo.toml`, `action.yml`, and `Dockerfile`
+  - Run `cargo build` to update `Cargo.lock` with the new version. This step is optional but recommended.
 
 2. **Create and merge the pull request:**
-   - Create a pull request from the release branch to `master`
-   - Once approved and merged, the tag will be pushed automatically
+  - Create a pull request from the release branch to `master`
+  - Once approved, merge the pull request
 
 3. **Create the GitHub release:**
-   - The CI/CD pipeline will detect the version tag and create the release automatically
-   - Add the release notes to the GitHub release description
+  - Make sure that you're on the `master` branch and have pulled the latest changes
+  - Create a version tag (e.g., `vM.m.p`, like `v1.0.h6`) and push it to GitHub by running:
+    ```bash
+    git tag vM.m.p
+    git push origin vM.m.p
+    ```
+  - The release workflow will detect the version tag and create the release automatically
+  - Add the release notes to the GitHub release description
 
 4. **Update Homebrew:**
    - Update the [Homebrew repo](https://github.com/Screenly/homebrew-screenly-cli) with the latest version