update README, version, cargo update

This commit is contained in:
Vinzenz Schroeter 2025-02-28 22:46:33 +01:00
parent 70cc466253
commit ae1571bcd1
4 changed files with 147 additions and 62 deletions

View file

@ -37,10 +37,10 @@ cargo run -- <args>
Usage: servicepoint-cli [OPTIONS] <COMMAND>
Commands:
reset-everything [aliases: r]
pixels [aliases: p]
brightness [aliases: b]
stream [aliases: s]
reset-everything Reset both pixels and brightness [aliases: r]
pixels Commands for manipulating pixels [aliases: p]
brightness Commands for manipulating the brightness [aliases: b]
stream Continuously send data to the display [aliases: s]
help Print this message or the help of the given subcommand(s)
Options:
@ -59,52 +59,58 @@ Usage: servicepoint-cli stream <COMMAND>
Commands:
stdin Pipe text to the display, example: `journalctl | servicepoint-cli stream stdin`
screen Stream the default source to the display. On Linux Wayland, this pops up a screen or window chooser, but it also may directly start streaming your main screen.
help Print this message or the help of the given subcommand(s)
```
#### Screen
```
Stream the default source to the display. On Linux Wayland, this pops up a screen or window chooser, but it also may directly start streaming your main screen.
Usage: servicepoint-cli stream screen [OPTIONS]
Options:
-n, --no-dither Disable dithering
-p, --pointer Show mouse pointer in video feed
-h, --help Print help
--no-hist Disable histogram correction
--no-blur Disable blur
--no-sharp Disable sharpening
--no-dither Disable dithering. Brightness will be adjusted so that around half of the pixels are on.
```
#### Stdin
```
Pipe text to the display, example: `journalctl | servicepoint-cli stream stdin`
Usage: servicepoint-cli stream stdin [OPTIONS]
Options:
-s, --slow
-h, --help Print help
-s, --slow Wait for a short amount of time before sending the next line
```
### Brightness
```
Commands for manipulating the brightness
Usage: servicepoint-cli brightness <COMMAND>
Commands:
max Reset brightness to the default (max) level [aliases: r, reset]
set Set one brightness for the whole screen [aliases: s]
min Set brightness to lowest possible level.
help Print this message or the help of the given subcommand(s)
```
### Pixels
```
Commands for manipulating pixels
Usage: servicepoint-cli pixels <COMMAND>
Commands:
off Reset all pixels to the default (off) state [aliases: r, reset]
off Reset all pixels to the default (off) state [aliases: r, reset, clear]
invert Invert the state of all pixels [aliases: i]
on Set all pixels to the on state
help Print this message or the help of the given subcommand(s)
```
## Contributing