From 871d6bd8f8a1f9c33f79a1c65e0ead94e7df1c9b Mon Sep 17 00:00:00 2001 From: Cedoor Date: Fri, 14 Jun 2024 15:34:52 +0100 Subject: [PATCH] docs: update README.md --- README.md | 41 +++++++++++++++++++++++++++++++---------- 1 file changed, 31 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7723dd0..9bad74a 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ Package Version Downloads - Audit + Audited @@ -87,9 +87,8 @@ - - Semaphore_4.0.0_Audit.pdf + ✔️ @@ -111,7 +110,9 @@ Downloads - + + ❌ + @@ -131,7 +132,9 @@ Downloads - + + ❌ + @@ -151,7 +154,9 @@ Downloads - + + ❌ + @@ -171,7 +176,9 @@ Downloads - + + ❌ + @@ -238,12 +245,26 @@ yarn compile ### Releases -Bump a new version for your package with: +1. Bump a new version of the package with: ```bash yarn version:bump # e.g. yarn version:bump utils 2.0.0 ``` -It will create a commit and a git tag that you'll need to push on the main branch. A workflow will be triggered and will -publish your package on [npm](https://www.npmjs.com/) and release a new version on Github with its changelogs automatically. +This step creates a commit and a git tag. + +2. Push the changes to main: + +```bash +git push origin main +``` + +3. Push the new git tag: + +```bash +git push origin - +# e.g. git push origin utils-v2.0.0 +``` + +After pushing the new git tag, a workflow will be triggered and will publish the package on [npm](https://www.npmjs.com/) and release a new version on Github with its changelogs automatically.