Skip to content

Commit

Permalink
updated README for logo and homebrew
Browse files Browse the repository at this point in the history
  • Loading branch information
cxreiff committed Aug 16, 2024
1 parent 516ca4c commit 5943c1b
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ Triggering immediately works in any shell, triggering after a delay is currently
## installation

```sh
cargo install --locked ttysvr`
# cargo
cargo install --locked ttysvr
```
```sh
# homebrew
brew install cxreiff/tap/ttysvr
```

## usage
Expand All @@ -22,6 +27,12 @@ Starts the screensaver immediately. If no variant is specified, one is randomly
ttysvr [VARIANT]
```

Some variants have subvariants.

```sh
ttysvr [VARIANT] [SUBVARIANT]
```

Sets up the screensaver to activate after `DELAY` seconds of inactivity in your current shell session.
```sh
eval `ttysvr [VARIANT] --init [DELAY]`
Expand All @@ -41,11 +52,11 @@ eval `ttysvr --cancel`
## variants

| | |
|---------|---------------------|
| maze | not yet implemented |
| pipes | not yet implemented |
| bubbles | not yet implemented |
| variant | subvariants? | description |
|---------|--------------|--------------------------------------------|
| bubbles | | Colorful bubbles bounce around the screen. |
| logo | `dvd`, `tty` | DVD player style bouncing logo. |
| maze | | Not yet implemented. |

## compatibility

Expand Down

0 comments on commit 5943c1b

Please sign in to comment.