Skip to content

Commit 3947f85

Browse files
committed
update readme
1 parent 9d51a28 commit 3947f85

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# TODO
1+
# SolidState Smart Contract Project
22

3-
TODO: This repository was generated from a template or is the template itself. To setup a new project, find all occurrences of "TODO" and replace with relevant text.
3+
> Note: This repository was generated from a template or is the template itself. To set up a new project, set the missing data marked "TODO" in `package.json` and remove this notice.
4+
5+
This project is built with [SolidState](https://github.com/solidstate-network). See the [solidstate-solidity](https://github.com/solidstate-network/solidstate-solidity) documentation for information about contract integration and testing.
46

57
## Development
68

@@ -22,8 +24,6 @@ Compile contracts via Hardhat:
2224
yarn run hardhat compile
2325
```
2426

25-
Note: This template comes with `@solidstate/contracts` and `@solidstate/spec` installed by default. For more information visit [solidstate/solidity](https://github.com/solidstate-network/solidstate-solidity).
26-
2727
### Networks
2828

2929
By default, Hardhat uses the Hardhat Network in-process.
@@ -56,7 +56,7 @@ yarn run hardhat coverage
5656

5757
### Documentation
5858

59-
A documentation site is output on contract compilation to the `docgen` directory. It can also be generated manually:
59+
A static documentation site can be generated using `hardhat-docgen`:
6060

6161
```bash
6262
yarn run hardhat docgen

0 commit comments

Comments
 (0)