chore: mini readme instructions

README.md

@@ -1,2 +1,27 @@
-# typescript-hardhat-template
-A Template Project To Start Solidity Development With Hardhat and Typescript
+# TypeScript Solidity Boilerplate Starter Kit
+
+A BoilerPlate Template Project To Start Solidity Development With Hardhat and Typescript
+
+Check the Hardhat documentation for more information. 
+
+https://hardhat.org/getting-started/
+
+
+We recommend installing `hh autocomplete` so you can use `hh` shorthand globally.
+
+`npm i -g hardhat-shorthand`
+
+https://hardhat.org/guides/shorthand.html
+
+## Usage
+
+- `hh compile` - compile smart contract and generate typechain ts bindings
+- `hh test` - run tests
+- `hh deploy` - deploy to local network (see options for more)
+- `hh TABTAB` - autocomplete - check for other tasks and options
+
+
+Check `package.json` scripts for more options.
+Use `.env.example` file and adapt it to you values and settings.
+
+Have Fun!

package.json

@@ -4,13 +4,10 @@
     "description": "",
     "scripts": {
         "test": "hardhat test",
-        "test-integration": "hardhat test test/integration/APIConsumer_int_test.js --network kovan; hardhat test test/integration/RandomNumberConsumer_int_test.js --network kovan",
         "lint:fix": "prettier --write 'scripts/**/*.{js,ts}' 'test/**/*.{js,ts}' 'tasks/**/*.{js,ts}' && tslint --fix --config tslint.json --project tsconfig.json && solhint contracts/**/*.sol",
         "lint": "tslint --config tslint.json --project tsconfig.json && solhint contracts/**/*.sol",
         "format": "prettier --check \"**/*.{ts,js,sol}\"",
-        "format:fix": "prettier --write \"**/*.{ts,js,sol}\"",
-        "build": "tsc",
-        "watch": "tsc -w"
+        "format:fix": "prettier --write \"**/*.{ts,js,sol}\""
     },
     "files": [
         "dist/src/",