Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adzialocha authored Aug 30, 2023
1 parent 43bc1fe commit da3e8b2
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions aquadoggo_cli/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<h1 align="center">aquadoggo CLI</h1>

<div align="center">
<strong>Node for the p2panda network</strong>
<strong>p2panda network node</strong>
</div>

<br />
Expand All @@ -25,7 +25,7 @@
<br/>

Configurable node for the [`p2panda`] network, which runs as a command line
application on any computer, raspberry pi or server.
application on any computer, Raspberry Pi or server.

## Installation

Expand Down Expand Up @@ -57,6 +57,9 @@ cp ./target/release/aquadoggo ~/.local/bin
# For experimental setups it is enough to just start the node!
aquadoggo

# Enable logging
aquadoggo --log-level info

# By default the config.toml is loaded from the same folder or from the XDG
# data directory, but you can also specify a custom path
aquadoggo -c ../config.toml
Expand Down Expand Up @@ -157,6 +160,13 @@ Options:
[possible values: true, false]
-l, --log-level <LEVEL>
Set log verbosity. Use this for learning more about how your node behaves or for debugging.
Possible log levels are: ERROR, WARN, INFO, DEBUG, TRACE. They are scoped to "aquadoggo" by default.
If you want to adjust the scope for deeper inspection use a filter value, for example "=TRACE" for logging _everything_ or "aquadoggo=INFO,libp2p=DEBUG" etc.
-h, --help
Print help (see a summary with '-h')
Expand All @@ -168,7 +178,7 @@ Options:

```bash
# Run node during development with logging enabled
RUST_LOG=aquadoggo=debug cargo run
LOG_LEVEL=debug cargo run

# Run tests
cargo test
Expand All @@ -186,7 +196,7 @@ GNU Affero General Public License v3.0 [`AGPL-3.0-or-later`](LICENSE)

*This project has received funding from the European Union’s Horizon 2020
research and innovation programme within the framework of the NGI-POINTER
Project funded under grant agreement No 871528*
Project funded under grant agreement No 871528 and NGI-ASSURE No 957073*

[`config.toml`]: config.toml
[`p2panda`]: https://p2panda.org

0 comments on commit da3e8b2

Please sign in to comment.