Skip to content

Commit 24c6c3f

Browse files
sslivkoffsslivkoff
authored
Update README.md
1 parent fbc22f9 commit 24c6c3f

1 file changed

Lines changed: 14 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
# Multiple Endpoint Shared Configuration (MESC) Standard
33

44
[![Specification](https://img.shields.io/badge/Spec-blueviolet)](https://github.com/paradigmxyz/mesc/blob/main/SPECIFICATION.md)
5-
[![issues - badge-generator](https://img.shields.io/badge/Docs-green)](https://paradigmxyz.github.io/mesc)
5+
[![issues - badge-generator](https://img.shields.io/badge/Docs-blueviolet)](https://paradigmxyz.github.io/mesc)
6+
[![Rust Tests](https://github.com/paradigmxyz/mesc/workflows/Rust%20Tests/badge.svg)](https://github.com/paradigmxyz/mesc/tree/main/tests)
7+
[![Python Tests](https://github.com/paradigmxyz/mesc/workflows/Python%20Tests/badge.svg)](https://github.com/paradigmxyz/mesc/tree/main/tests)
8+
69

710
MESC is a standard for how crypto tools configure their RPC endpoints. By following this specification, a user creates a single RPC configuration that can be shared by all crypto tools on their system.
811

@@ -12,6 +15,8 @@ MESC has two main design goals:
1215

1316
MESC is formally defined in [SPECIFICATION.md](./SPECIFICATION.md).
1417

18+
Additional information can be found in the [MESC Documentation](https://paradigmxyz.github.io/mesc/).
19+
1520
### Contents
1621
- [Reference Implementations](#reference-implementations)
1722
- [Quickstart](#quickstart)
@@ -33,18 +38,19 @@ These implementations provide a consistent language-agnostic interface while sti
3338

3439
## Quickstart
3540

36-
The interactive [`mesc`](./cli) CLI tool makes it easy to create and manage a MESC configuration.
37-
1. Install: `cargo install mesc_cli`
38-
2. Create config interactively: `mesc setup`
41+
The quickest way to use MESC is:
42+
1. create a `mesc.json` config file
43+
2. set the `MESC_PATH` environment variable to the path of this file
3944

40-
To create a MESC config manually:
41-
1) Create a JSON file (can use [the example](./SPECIFICATION.md#example-rpcconfig) from the spec as a template).
42-
2) Set `MESC_PATH` to the path of this JSON file.
45+
These steps can be performed automatically using the interactive [`mesc`](./cli) CLI tool:
46+
1. Install: `cargo install mesc_cli`
47+
2. Perform interactive setup: `mesc setup`
4348

4449
## Tutorial
4550

46-
Below is a brief tutorial on MESC. For more detail, see [SPECIFICATION.md](./SPECIFICATION.md).
51+
Below is a brief tutorial on MESC. For more detail, see the MESC [Specification](./SPECIFICATION.md) and [Documentation](https://paradigmxyz.github.io/mesc).
4752

53+
Topics:
4854
- [Tracked Information](#tracked-information)
4955
- [Common Interface](#common-interface)
5056
- [Typical Usage](#typical-usage)

0 commit comments

Comments
 (0)