Skip to content

Commit 454b2ed

Browse files
committed
fix: add missing docs files
1 parent 84c9706 commit 454b2ed

File tree

3 files changed

+77
-3
lines changed

3 files changed

+77
-3
lines changed

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,6 @@ out/
2525
/broadcast/*/31337/
2626
/broadcast/**/dry-run/
2727

28-
# Docs
29-
docs/
30-
3128
# Dotenv file
3229
.env
3330

docs/basic-usage.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Basic Usage
2+
3+
## Build
4+
5+
You can either use Forge:
6+
7+
```shell
8+
btp-scs foundry build
9+
```
10+
11+
or Hardhat:
12+
13+
```shell
14+
btp-scs hardhat build
15+
```
16+
17+
## Test
18+
19+
With Forge:
20+
21+
```shell
22+
btp-scs foundry test
23+
```
24+
25+
or Hardhat:
26+
27+
```shell
28+
btp-scs hardhat test
29+
```
30+
31+
## Format
32+
33+
To format your contracts, run
34+
35+
```shell
36+
btp-scs foundry format
37+
```
38+
39+
## Deploy to local network
40+
41+
You can deploy your contracts to a local network. First, run
42+
43+
```shell
44+
btp-scs hardhat network
45+
```
46+
47+
then:
48+
49+
```shell
50+
btp-scs hardhat deploy local -m ignition/modules/main.ts
51+
```
52+
53+
## Deploy to platform network
54+
55+
You can also deploy your contracts to the network running on the platform by executing the following command:
56+
57+
```shell
58+
btp-scs hardhat deploy remote -m ignition/modules/main.ts
59+
```
60+
61+
## Help
62+
63+
To get info about the tasks, run:
64+
65+
```shell
66+
btp-scs --help
67+
```

docs/subgraph.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Subgraph Usage
2+
3+
## Deploy your subgraph
4+
5+
To index your smart contract events, use The Graph middleware.
6+
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:
7+
8+
```shell
9+
btp-scs subgraph deploy
10+
```

0 commit comments

Comments
 (0)