From 7cb0def4bb5e8e14aa48aac27fd228f6cfb1d0b8 Mon Sep 17 00:00:00 2001
From: luiz <luiz_tauffer@hotmail.com>
Date: Wed, 11 Sep 2024 10:56:26 +0200
Subject: [PATCH] publish instructions

---
 README.md | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 98342be..6ad1ac9 100644
--- a/README.md
+++ b/README.md
@@ -135,7 +135,10 @@ npm run build:linux
 Publishing will happen every time a new push is maded to the `main` branch with a tag associated, creating a release at [release page](https://github.com/catalystneuro/vame-desktop/releases).
 
 To avoid unecessary releases, follow these steps:
-- create a branch `git checkout -b <branch_name>`, work on it, and create a pull request once the job is done.
-- create a new tag with `git tag v<tag_number>`, push it to the repo with `git push orgin --tags`.
-- merge the PR from `<branch_name>` into `main`. The github actions will create a [Draft Release](https://github.com/catalystneuro/vame-desktop/releases) where you can manually add extra info, and finaly approve and publish.
+- Create a branch `git checkout -b <branch_name>`, work on it, and create a pull request to `main`.
+- Update the `package.json` with the new version number.
+- Create a new tag with `git tag v<tag_number>`, push it to the repo with `git push orgin --tags`. **IMPORTANT**: the tag must be in the format `vX.Y.Z` where `X.Y.Z` is the package version number in `package.json`.
+- Merge the PR from `<branch_name>` into `main`. The github actions will create a [Draft Release](https://github.com/catalystneuro/vame-desktop/releases).
+- Manually edit the draft release, add information about the new features, bug fixes, and breaking changes.
+- Finaly approve and publish the new release.