Skip to content

Commit 35c86f1

Browse files
committed
update readmes
1 parent d4b154a commit 35c86f1

File tree

4 files changed

+115
-156
lines changed

4 files changed

+115
-156
lines changed

README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
# The Graph networks registry
22

3-
This repository manages a registry of networks in The Graph ecosystem. See [Releases](https://github.com/pinax-network/supported-networks/releases) page for the latest version of the registry. See [docs/networks-table.md](./docs/networks-table.md) for the up-to-date auto-generated networks table.
3+
[![GitHub Release](https://img.shields.io/github/v/release/graphprotocol/networks-registry)](https://github.com/graphprotocol/networks-registry/releases/latest)
4+
5+
This repository manages a registry of networks in The Graph ecosystem.
6+
7+
See [Releases](https://github.com/graphprotocol/networks-registry/releases) page for the latest version of the registry.
8+
See [Networks Table](./docs/networks-table.md) for an up-to-date auto-generated networks list.
9+
10+
[Libraries](https://github.com/pinax-network/graph-networks-libs) for Typescript, Go and Rust.
11+
12+
[Demo app](https://graph-networks-app.vercel.app/) for the registry.
413

514
## Adding/updating a chain
615

@@ -12,9 +21,9 @@ This repository manages a registry of networks in The Graph ecosystem. See [Rele
1221

1322
## Structure of the repository
1423

15-
- `docs/`: Contains docs and auto-generated networks table
1624
- `schemas/`: Contains the schema for the registry
1725
- `registry/`: Contains the networks JSONs (edit these)
26+
- `docs/`: Contains docs and auto-generated networks table
1827
- `public`: Contains all generated registry versions (don't edit those)
1928
- `src/`: Contains scripts to validate networks JSONs and generate the resulting registry JSON
2029

@@ -72,9 +81,9 @@ In addition to the above, the JSON Schema is available at TheGraphNetworksRegist
7281

7382
## Registry Usage
7483

75-
In your application you can pull one of the registry JSONs above depending on your use case - whether it's pinned to a specific registry version, whether you allow backwards compatible schema changes or you just need the latest one.
84+
In your application you can use one of the generated registry JSONs above depending on your use case.
7685

77-
Refer to [Using The Graph Networks Registry](./docs/using-the-registry.md) for more information and best practices.
86+
Libraries for Typescript, Go and Rust [exist](https://github.com/pinax-network/graph-networks-libs) to make it easier to work with the registry.
7887

7988
Typical use cases:
8089

@@ -85,6 +94,7 @@ Typical use cases:
8594

8695
## References
8796

97+
- [The Graph Networks Registry libraries](https://github.com/pinax-network/graph-networks-libs)
8898
- [Ethereum chains list](https://github.com/ethereum-lists/chains)
8999
- [CAIP-2 chain ids](https://chainagnostic.org/CAIPs/caip-2)
90100
- [Web3Icons](https://github.com/0xa3k5/web3icons/tree/main/raw-svgs/networks/branded)

0 commit comments

Comments
 (0)