Skip to content

Commit

Permalink
fix: README
Browse files Browse the repository at this point in the history
  • Loading branch information
oleonardolima committed Apr 20, 2022
1 parent 4370e25 commit a53082c
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,39 @@
# A terminal block explorer for mempool.space websocket

A terminal block explorer exposing the features available on mempool.space websocket API [mempool.space websocket API](https://mempool.space/docs/api/websocket).
A terminal block explorer exposing the features available on [mempool.space websocket API](https://mempool.space/docs/api/websocket).

Currently available features are:
- All data feed from mempool.space for: blocks, mempool-blocks, live-2h-chart, and stats.
- Subscription for address related data: track-address.

## How to use:
<br>

To use this CLI you must have rust and cargo installed in your computer, you can check it wih:
## Requirements:

``` sh
rustc --version
```
To use this CLI you must have rust and cargo installed in your computer, you can check it with:

``` sh
# check rust version, it should return its version if installed
rustc --version
# check cargo version, it should return its version if installed
cargo --version
```

If you do not have it installed, you can follow this tutorial from [The Rust Programming Language book](https://doc.rust-lang.org/book/ch01-01-installation.html)


<br>

## How to use:

If you have cargo and rust installed, you can run the following commands:

``` sh
# mainnet connection is default
cargo run -- track-address <your-btc-address>
cargo run -- track-address -a <your-btc-address>

# to use testnet
cargo run -- track-address <your-btc-address> --endpoint mempool.space/testnet/api
cargo run -- --endpoint mempool.space/testnet/api track-address -a <your-btc-address>
```

``` sh
Expand Down

0 comments on commit a53082c

Please sign in to comment.