parent
ef19ab8b3f
commit
83baf7b419
5 changed files with 90 additions and 21 deletions
64
README.md
64
README.md
|
@ -31,13 +31,75 @@ cd servicepoint-cli
|
|||
cargo run -- <args>
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
Usage: servicepoint-cli [OPTIONS] <COMMAND>
|
||||
|
||||
Commands:
|
||||
reset-everything [aliases: r]
|
||||
pixels [aliases: p]
|
||||
brightness [aliases: b]
|
||||
stream [aliases: s]
|
||||
help Print this message or the help of the given subcommand(s)
|
||||
|
||||
Options:
|
||||
-d, --destination <DESTINATION> ip:port of the servicepoint display [default: 127.0.0.1:2342]
|
||||
-t, --transport <TRANSPORT> protocol to use for communication with display [default: udp] [possible values: udp, web-socket, fake]
|
||||
-v, --verbose verbose logging
|
||||
-h, --help Print help
|
||||
-V, --version Print version
|
||||
```
|
||||
|
||||
### Stream
|
||||
|
||||
```
|
||||
Usage: servicepoint-cli stream <COMMAND>
|
||||
|
||||
Commands:
|
||||
stdin
|
||||
screen
|
||||
help Print this message or the help of the given subcommand(s)
|
||||
|
||||
Options:
|
||||
-h, --help Print help
|
||||
```
|
||||
|
||||
### Brightness
|
||||
|
||||
```
|
||||
Usage: servicepoint-cli brightness <COMMAND>
|
||||
|
||||
Commands:
|
||||
reset [aliases: r]
|
||||
set [aliases: s]
|
||||
min
|
||||
max
|
||||
help Print this message or the help of the given subcommand(s)
|
||||
|
||||
Options:
|
||||
-h, --help Print help
|
||||
```
|
||||
|
||||
### Pixels
|
||||
```
|
||||
Usage: servicepoint-cli pixels <COMMAND>
|
||||
|
||||
Commands:
|
||||
reset [aliases: r]
|
||||
help Print this message or the help of the given subcommand(s)
|
||||
|
||||
Options:
|
||||
-h, --help Print help
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
If you have ideas on how to improve the code, add features or improve documentation feel free to open a pull request.
|
||||
|
||||
You think you found a bug? Please open an issue.
|
||||
|
||||
Submissions on Forgejo are preferred, but you can also use GitHub.
|
||||
Submissions on [Forgejo](https://git.berlin.ccc.de/servicepoint/servicepoint-cli) are preferred, but you can also use [GitHub](https://github.com/kaesaecracker/servicepoint-cli).
|
||||
|
||||
All creatures welcome.
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue