Skip to content
Permalink
Browse files

Update README.md adding help screen with flag usage

  • Loading branch information...
mikispag committed Nov 17, 2018
1 parent 243a5ac commit 2377f54f56351e9d98d2303e821f52d347ff03ce
Showing with 18 additions and 7 deletions.
  1. +18 −7 README.md
@@ -18,14 +18,25 @@ Enable the desired *visitor* (by default, the Clusterizer is on) in `src/main.rs
target/release/bitiodine-rust
```

### Custom blockchain directory

By default, Bitiodine uses the standard `~/.bitcoin/blocks` directory.
If you need to use a different one, you must create a symbolic link:

```
mkdir ~/.bitcoin
ln -sf /path/to/blocks ~/.bitcoin/blocks
$ ./bitiodine-rust --help
BitIodine 0.0.2
Michele Spagnuolo <mikispag@gmail.com>
A Rust Bitcoin blockchain parser with clustering capabilities, allowing to group together addresses in ownership
clusters.
USAGE:
bitiodine-rust [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
-v Sets the level of verbosity
-V, --version Prints version information
OPTIONS:
-b, --blocks-dir <BLOCKS_DIRECTORY_PATH> Sets the path to the bitcoind blocks directory [default:
/home/$USER/.bitcoin/blocks]
-o, --output <OUTPUT_FILE> Sets the path to the output clusters.csv file [default: clusters.csv]
```

## Credits

0 comments on commit 2377f54

Please sign in to comment.
You can’t perform that action at this time.