浏览代码

docs: more information

Kristjan Kosic 4 年之前
父节点
当前提交
e357969a4c
共有 1 个文件被更改,包括 11 次插入2 次删除
  1. 11 2
      README.md

+ 11 - 2
README.md

@@ -1,6 +1,14 @@
 # TypeScript Solidity Boilerplate Starter Kit
 
-A BoilerPlate Template Project To Start Solidity Development With Hardhat and Typescript
+A BoilerPlate Template Project To Start Solidity Development With Hardhat and Typescript. All you have to do is create a new repository from the template and start coding your smartcontracts. 
+
+## Hardhat Configuration
+
+- typescript support enabled
+- typechain plugin installed (typescript type bindings are generated from smart contracts)/check Typechain docs
+- hardhat-deploy plugin enabled (use deployments from `deploy` folder, order and tag them. Multinetwork deployments supported)
+- hardhat console enabled - to allow of 'solidity' console.log usage
+- testing environment configured and operational
 
 Check the Hardhat documentation for more information. 
 
@@ -20,7 +28,8 @@ Run `npm install` and then:
 - `hh compile` - to compile smart contract and generate typechain ts bindings
 - `hh test` - to run tests
 - `hh deploy` - to deploy to local network (see options for more)
-- `hh TABTAB` - to use autocomplete.
+- `hh TABTAB` - to use autocomplete
+- `hh node` - to run a localhost node
 
 
 Check `package.json` scripts for more options.