From 42639662c329aa4ba2016864f958d86004f071da Mon Sep 17 00:00:00 2001 From: sripwoud Date: Wed, 27 Nov 2024 12:36:36 +0700 Subject: [PATCH] docs: add `soldeer` install instructions (#903) * docs: add `soldeer` install instructions * update README --- packages/contracts/contracts/README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/packages/contracts/contracts/README.md b/packages/contracts/contracts/README.md index 22a953346..cf78ed20d 100644 --- a/packages/contracts/contracts/README.md +++ b/packages/contracts/contracts/README.md @@ -46,18 +46,16 @@ To learn more about contracts visit [semaphore.pse.dev](https://docs.semaphore.p ## 🛠 Install -### npm or yarn +You can install the semaphore protocol contracts with any node package manager (`bun`, `npm`, `pnpm`,`yarn`) or the solidity package manager [`soldeer`](https://soldeer.xyz). -Install the `@semaphore-protocol/contracts` package with npm: - -```bash +```commandline +bun add @semaphore-protocol/contracts npm i @semaphore-protocol/contracts -``` - -or yarn: - -```bash +pnpm add @semaphore-protocol/contracts yarn add @semaphore-protocol/contracts + +# for soldeer, an explicit version is required, e.g: +soldeer install semaphore-protocol-contracts~4.6.0 ``` ## 📜 Usage