Skip to content

Commit d95df80

Browse files
committed
[docs]: update README
1 parent e127d9a commit d95df80

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,21 @@ $ cargo run --
4141
```
4242

4343
## Configurations & Usage
44+
### Ethereum Statistics
45+
To see statistics information about Ethereum, you have to set an Etherscan's free API key.
46+
You can get it from [here](https://etherscan.io/apis).
47+
And set it to `api_key` field in `settings.toml`. You can use a setting template file (`settings.example.toml`).
48+
```sh
49+
$ mv ./settings.example.toml ./settings.toml
50+
```
51+
52+
### Configurations
4453
Please check the various settings such as endpoints using the following command:
4554
```sh
4655
cargo run -- --help
4756
```
4857

58+
### Usage
4959
The basic usage is as follows:
5060
- Press `q` to exit `lazy-etherscan`.
5161
- Press `s` to focus on the search bar, where you can perform searches for addresses, blocks, transactions, and more.
@@ -61,6 +71,7 @@ Please see [this issue](https://github.com/woxjro/lazy-etherscan/issues/1).
6171
## Contributing
6272
This project is currently in the Proof of Concept (PoC) stage.
6373
Contributions are kindly requested to be postponed until further notice.
74+
Crash reports are welcome, please create an issue to do that.
6475

6576
## Sponsors
6677
This project has been developed with a grant from the [Ethereum Foundation](https://ethereum.org/en/foundation/).

settings.example.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[etherscan]
2+
api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXX"

0 commit comments

Comments
 (0)