confetty/README.md
Ankush Menat 33fdf3ada2
chore: install instructions should specify version
`go install` won't work otherwise. `latest` seems good enough for now for this tool.
2022-11-01 23:04:51 +05:30

42 lines
644 B
Markdown

# Confetty
Confetti (or fireworks) inside your terminal.
<p align="center">
<img src="./assets/confetty.gif?raw=true" alt="Confetti in your TTY" />
</p>
### Preview
You can preview `confetty` through `ssh` (thanks to [charmbracelet/wish](https://github.com/charmbracelet/wish))
```bash
# Confetti
ssh -p 2222 ssh.caarlos0.dev
# Fireworks
ssh -p 2223 ssh.caarlos0.dev
```
### Installation
```
go install github.com/maaslalani/confetty@latest
```
### Usage
```
confetty
```
```
confetty fireworks
```
Press any key to cause more confetti / fireworks to appear.
<kbd>Ctrl-C</kbd> or <kbd>q</kbd> to exit.
#### Why?
¯\\\_(ツ)\_/¯