Skip to content

Commit ad9770a

Browse files
author
2075
committed
feat(docs): update readme
1 parent f47d5be commit ad9770a

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

readme.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,30 @@ Interacting, archiving and querying transactions on blockchain nodes can become
88
An indexer provides unified acces to historic data.
99

1010
## How
11-
12-
We have built a docker-compose to fire up the required elements pictured below:
11+
We have built a docker-compose to fire up a stack as pictured below:
1312

1413
![Schema](/doc/stack-basic.png)
1514

16-
How to get started:
15+
Get started:
1716

18-
1. setup your env vars or start with a clone of .env.example
19-
2. setup your archiver config and chainspec in ./config
20-
3. docker-compose up
17+
0. clone the repo `git clone https://github.com/playzero/substrate-graph && cd substrate-graph`
18+
1. setup your env vars or start with a clone of `.env.example`
19+
2. setup your archiver config and chainspec in `./config`
20+
3. `docker-compose up`
2121
4. log in to hasura `localhost:18080` and enter your admin password
2222
5. on the data tab, add all untracked items
2323
6. have phun in graphiql
2424

2525
## Status
2626

27-
- [X] docker-compose basic skeleton
28-
- [X] complete setup for polkadot
29-
- [X] complete setup for custom substrate nodes (substrate node template)
30-
- [X] config examples
31-
- [ ] tests
32-
- [ ] docker-compose
27+
- [X] add polkadot
28+
- [X] add custom substrate nodes (substrate node template)
29+
- [X] add config examples
30+
- [X] add docker-compose
3331
- [ ] add load balancer
34-
- [ ] add dashboard
32+
- [ ] add monitoring dashboard
33+
- [ ] add subscriptions
34+
- [ ] add frontend example
3535

3636
## Support us
3737

0 commit comments

Comments
 (0)