Skip to content

Commit

Permalink
docs: tweak example commmand text
Browse files Browse the repository at this point in the history
  • Loading branch information
kanej committed Jun 18, 2024
1 parent b80febf commit d9fc7a8
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions examples/upgradeable/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
# Hardhat Sample for Hardhat Ignition
# Upgradeable Contract Example for Hardhat Ignition

This project is a basic example of how to use Hardhat Ignition with contract systems that use an upgradeable proxy pattern.

## Deploying

To run the Ignition deploy against the ephemeral hardhat network:
To deploy the an example proxy contract against the ephemeral Hardhat network:

```shell
npx hardhat ignition deploy ./ignition/modules/ProxyModule.js
```

To deploy an example of a proxy contract being upgraded against the ephemeral Hardhat network:

# or to deploy the upgrade module
```shell
npx hardhat ignition deploy ./ignition/modules/UpgradeModule.js
```

## Test

To run the hardhat tests using Ignition:
To run the Hardhat tests using Ignition:

```shell
npm run test
Expand Down

0 comments on commit d9fc7a8

Please sign in to comment.