Skip to content

Commit

Permalink
docs: update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulRBerg committed Dec 4, 2023
1 parent 2a958f1 commit 9ca1095
Showing 1 changed file with 6 additions and 21 deletions.
27 changes: 6 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,35 +79,20 @@ Alternatively, you can:

You can get access to the Solidity code and the ABIs programmatically.

### Foundry

First, run the install step:
All users are recommended to install PRBProxy as a Node.js package:

```sh
forge install PaulRBerg/prb-proxy@release-v4
pnpm add @prb/math
```

Your `.gitmodules` file should now contain the following entry:
This example uses Pnpm, but using Yarn or Npm is also possible.

```toml
[submodule "lib/prb-proxy"]
branch = "release-v4"
path = "lib/prb-proxy"
url = "https://github.com/PaulRBerg/prb-proxy"
```
### Foundry

Finally, add this to your `remappings.txt` file:
If you're using Foundry, you have to add this to your `remappings.txt` file:

```text
prb-proxy/=lib/prb-proxy/
```

### Hardhat

PRBProxy is available as an npm package:

```sh
pnpm add @prb/proxy
@prb/proxy/=node_modules/@prb/proxy/
```

## Usage
Expand Down

0 comments on commit 9ca1095

Please sign in to comment.