Skip to content

Commit 982cef5

Browse files
committed
docs(README): improve doc with build and install sections
1 parent da6c3a8 commit 982cef5

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

+24-5
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@
1414

1515
## Purpose
1616

17-
This CLI tool offers a straightforward way to extract diverse data from Cosmos chains using the application file store.
18-
19-
Initially developed for Axone’s internal needs, it provides a versatile foundation for addressing various data extraction requirements.
17+
`cosmos-extractor` is a CLI tool designed to extract various types of data from Cosmos chain snapshots. Originally built for [Axone](https://axone.xyz)’s internal needs, it’s open for anyone who wants to dig into Cosmos-based blockchains.
2018

2119
## Features
2220

@@ -26,6 +24,27 @@ Initially developed for Axone’s internal needs, it provides a versatile founda
2624
## Usage example
2725

2826
```bash
29-
# Export delegators and their delegations to a CSV file
30-
$ cosmos-extractor extract delegators ./data/bitsong/data --chain-name bitsong --output ./extracts/bitsong-delegators.csv
27+
# Export delegators and their delegations to a CSV file for the Bitsong chain if they have between 1000 and 1500 BTSG staked.
28+
$ cosmos-extractor extract delegators ./bitsong/data \
29+
--chain-name bitsong \
30+
--output ./extracts/bitsong-delegators.csv \
31+
--hrp cosmos \
32+
--min-shares 1000000000 \
33+
--max-shares 1500000000
34+
```
35+
36+
## Build
37+
38+
The project uses [Make](https://www.gnu.org/software/make/) for building and managing the project. To build the project, run the following command:
39+
40+
```bash
41+
make build
42+
```
43+
44+
## Install
45+
46+
To install the CLI tool, run the following command:
47+
48+
```bash
49+
make install
3150
```

0 commit comments

Comments
 (0)