From a53082cb641f1846fb8fbf8c07066c0362274975 Mon Sep 17 00:00:00 2001 From: Leonardo L Date: Wed, 20 Apr 2022 20:28:03 -0300 Subject: [PATCH] fix: README --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b1baf00..7f025a3 100644 --- a/README.md +++ b/README.md @@ -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: +
-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) + + +
+ +## 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 +cargo run -- track-address -a # to use testnet -cargo run -- track-address --endpoint mempool.space/testnet/api +cargo run -- --endpoint mempool.space/testnet/api track-address -a ``` ``` sh