Skip to content

Commit

Permalink
Write a little bit about configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
adzialocha committed Aug 25, 2023
1 parent 8d9aebb commit fc9135b
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions aquadoggo_cli/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,32 @@
# aquadoggo CLI

Node server with GraphQL API for the p2panda network.
Configurable node for the p2panda network.

## Usage

`aquadoggo` is a powerful node implementation which can run in very different setups during development and in production. It can be configured through a `config.toml` file, environment variables and command line arguments, depending on your needs.

Check out the [`config.toml`](config.toml) file for all configurations and documentation.

```bash
# Show all possible command line arguments
aquadoggo --help

# Run aquadoggo in local development mode (default)
aquadoggo
```

## Development

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

# Run all tests
cargo test
cargo build

# Compile release binary
cargo build --release
```

## License
Expand Down

0 comments on commit fc9135b

Please sign in to comment.