confetty/README.md
2022-03-24 00:32:55 -04:00

42 lines
637 B
Markdown

# Confetty
Confetti (or fireworks) inside your terminal.
<p align="center">
<img src="./assets/confetti.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
```
### 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?
¯\\\_(ツ)\_/¯