You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+13-9
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,15 @@ This is the monorepo for Cannon. If you’re just interested in using the projec
4
4
5
5
For more information, please see documentation in the modules listed below:
6
6
7
-
8
-
-[`cli`](packages/cli): Source code for the CLI, accessible at `npx @usecannon/cli <package:version>`. This downloads a package from the registry, optionally exports deployment data, and runs the package on an [Anvil](https://github.com/foundry-rs/foundry/tree/master/anvil) node
9
-
-[`hardhat-cannon`](packages/hardhat-cannon): Main plugin module which is imported into packages
10
-
-[`registry`](packages/registry): Contains source and deployment code for the IPFS registry
11
-
-[`registry-subgraph`](packages/registry-subgraph): Indexes the registry contract onto The Graph for display on the website explorer
12
-
-[`sample-project`](packages/sample-project): Demonstrates the core functionality of the `hardhat-cannon` module
7
+
-[`cli`](packages/cli): The command-line interface. Run `npx @usecannon/cli --help` for usage information.
8
+
-[`builder`](packages/builder): Builds chain data from cannonfiles. (This is used by the CLI.)
9
+
-[`hardhat-cannon`](packages/hardhat-cannon): Code for the Hardhat plug-in, which wraps the CLI functionality with defaults pulled from a Hardhat project configuration.
10
+
-[`registry`](packages/registry): The smart contract for the package registry.
11
+
-[`registry-subgraph`](packages/registry-subgraph): Indexes the registry contract onto The Graph for display on the website.
12
+
-[`website`](packages/website): The website, hosted at https://usecannon.com
13
+
-[`sample-hardhat-project`](packages/sample-hardhat-project): Hardhat project that demonstrates the core functionality of the `hardhat-cannon` module
14
+
-[`sample-foundry-project`](packages/sample-hardhat-project): Foundry project that demonstrates the core functionality of the `cli` module
13
15
-[`contracts`](packages/contracts): Cannonfiles for standard contracts
14
-
-[`website`](packages/website): Source code for https://usecannon.com
15
-
-[`builder`](packages/builder): Contains source code that builds chain data from cannonfiles
16
16
17
17
## Development
18
18
@@ -22,6 +22,7 @@ To load an development version of Cannon, start by bootstrapping the project fro
Test changes to the Hardhat plug-in in the sample project:
40
41
41
42
```
42
-
cd ./packages/sample-project && npx hardhat cannon:build
43
+
cd ./packages/sample-hardhat-project && npx hardhat cannon:build
43
44
```
44
45
45
46
Preview updates to the website
@@ -48,3 +49,6 @@ Preview updates to the website
48
49
cd ./packages/website && npm run dev
49
50
```
50
51
52
+
### Publishing
53
+
54
+
With appropriate permissions on npm, publish updates using the [lerna publish](https://github.com/lerna/lerna/tree/main/commands/publish) command. For example, `npx lerna publish patch` will publish updated packages as the next patch version.
0 commit comments