.github/workflows/solidity.yml

@@ -195,6 +195,7 @@ jobs:
           rm -Rf README.md
           cp .github/BASE.md README.md
           ./genesis-output
+          echo "" >> README.md
           echo "\`\`\`json" >> README.md
           cat all_allocations.json >> README.md
           echo "\`\`\`" >> README.md

.gitignore

@@ -25,9 +25,6 @@ out/
 /broadcast/*/31337/
 /broadcast/**/dry-run/
 
-# Docs
-docs/
-
 # Dotenv file
 .env
 

docs/basic-usage.md

@@ -0,0 +1,67 @@
+# Basic Usage
+
+## Build
+
+You can either use Forge:
+
+```shell
+btp-scs foundry build
+```
+
+or Hardhat:
+
+```shell
+btp-scs hardhat build
+```
+
+## Test
+
+With Forge:
+
+```shell
+btp-scs foundry test
+```
+
+or Hardhat:
+
+```shell
+btp-scs hardhat test
+```
+
+## Format
+
+To format your contracts, run
+
+```shell
+btp-scs foundry format
+```
+
+## Deploy to local network
+
+You can deploy your contracts to a local network. First, run
+
+```shell
+btp-scs hardhat network
+```
+
+then:
+
+```shell
+btp-scs hardhat deploy local -m ignition/modules/main.ts
+```
+
+## Deploy to platform network
+
+You can also deploy your contracts to the network running on the platform by executing the following command:
+
+```shell
+btp-scs hardhat deploy remote -m ignition/modules/main.ts
+```
+
+## Help
+
+To get info about the tasks, run:
+
+```shell
+btp-scs --help
+```

docs/subgraph.md

@@ -0,0 +1,10 @@
+# Subgraph Usage
+
+## Deploy your subgraph
+
+To index your smart contract events, use The Graph middleware.
+First, edit `subgraph.config.json` to set the addresses of your smart contracts. You can find them in the deployment folder created under `ignation`. Then, run:
+
+```shell
+btp-scs subgraph deploy
+```