Skip to content

Commit 7f1281c

Browse files
committed
docs: Clean readme
1 parent 9509e9f commit 7f1281c

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,30 @@ Check how to export handlers with [Matchstick - Test Coverage documentation](htt
5151
> [!NOTE]
5252
> Since Matchstick code coverage is in very early stages, Matchstick cannot check for branch coverage, but rely on the assertion that a given handler has been called.
5353
54+
## Deployment Options
55+
56+
### Thegraph network
57+
58+
To deploy this subgraph on Thegraph network:
59+
60+
1. Set up your environment variables in `.env` file:
61+
62+
```bash
63+
SUBGRAPH_SLUG=your-subgraph-slug
64+
SUBGRAPH_DEPLOY_KEY=your-deploy-key
65+
SUBGRAPH_NETWORK_NAME=your-network-name
66+
VERSION_LABEL=your-version-label
67+
```
68+
69+
2. Deploy using the npm script:
70+
71+
```bash
72+
npm run deploy-studio
73+
```
74+
75+
### Self-Hosted Subgraph Deployment Process
76+
77+
5478
## Docker subgraph deployer
5579

5680
The subgraph is deploy via a generated Docker image.
@@ -134,8 +158,6 @@ choice(
134158
)
135159
```
136160

137-
The deployment process will automatically generate the appropriate subgraph configuration using the network-specific addresses and start blocks from `networks.json`.
138-
139161
## Changelog
140162

141163
Changes to this project are tracked in [CHANGELOG.md](./CHANGELOG.md)

0 commit comments

Comments
 (0)