Skip to content

Commit

Permalink
readme: added CLI reference section
Browse files Browse the repository at this point in the history
  • Loading branch information
luisnquin committed Apr 6, 2024
1 parent 96c9997 commit b796c59
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,20 @@ If you use [Home Manager](https://github.com/nix-community/home-manager) to mana

</details>

## CLI reference

```text
A customizable battery notifier for Linux kernels focused in BAT0 and BAT1
Usage: battery-notifier [OPTIONS]
Options:
-d, --debug-file <DEBUG_FILE> To simulate battery states (yaml)
-c, --config-file <CONFIG_FILE> The config file path (toml)
-h, --help Print help
-V, --version Print version
```

## Development

To develop and contribute to the project, use standard Cargo commands such as **build**, **run**, and **add**.
Expand Down

0 comments on commit b796c59

Please sign in to comment.