Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cedoor authored Jun 14, 2024
1 parent 15106bf commit 871d6bd
Showing 1 changed file with 31 additions and 10 deletions.
41 changes: 31 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<th>Package</th>
<th>Version</th>
<th>Downloads</th>
<th>Audit</th>
<th>Audited</th>
<tbody>
<tr>
<td>
Expand All @@ -87,9 +87,8 @@
</a>
</td>
<td>
<!-- Audit -->
<a href="https://semaphore.pse.dev/Semaphore_4.0.0_Audit.pdf">
Semaphore_4.0.0_Audit.pdf
✔️
</a>
</td>
</tr>
Expand All @@ -111,7 +110,9 @@
<img src="https://img.shields.io/npm/dm/@zk-kit/ecdh.circom.svg?style=flat-square" alt="Downloads" />
</a>
</td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
Expand All @@ -131,7 +132,9 @@
<img src="https://img.shields.io/npm/dm/@zk-kit/poseidon-cipher.circom.svg?style=flat-square" alt="Downloads" />
</a>
</td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
Expand All @@ -151,7 +154,9 @@
<img src="https://img.shields.io/npm/dm/@zk-kit/poseidon-proof.circom.svg?style=flat-square" alt="Downloads" />
</a>
</td>
<td></td>
<td>
</td>
</tr>
<tr>
<td>
Expand All @@ -171,7 +176,9 @@
<img src="https://img.shields.io/npm/dm/@zk-kit/utils.circom.svg?style=flat-square" alt="Downloads" />
</a>
</td>
<td></td>
<td>
</td>
</tr>
<tbody>
</table>
Expand Down Expand Up @@ -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 <package-name> <version>
# 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 <package-name>-<version>
# 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.

0 comments on commit 871d6bd

Please sign in to comment.