confetty/README.md
2022-11-05 15:08:56 -04:00

44 lines
672 B
Markdown

# Confetty
Confetti (or fireworks) inside your terminal.
<p align="center">
<img src="confetty.gif" alt="Confetti in your TTY" />
</p>
<p align="center">
<img src="fireworks.gif" alt="Fireworks in your TTY" />
</p>
### Installation
```bash
go install github.com/maaslalani/confetty@latest
```
### Preview
Get `confetty` in your terminal without installing through SSH.
```bash
ssh -p 2222 ssh.caarlos0.dev # Confetti
ssh -p 2223 ssh.caarlos0.dev # Fireworks
```
### Usage
```bash
confetty
```
```bash
confetty fireworks
```
Press any key to cause more confetti / fireworks to appear.
<kbd>Ctrl-C</kbd> or <kbd>q</kbd> to exit.
#### Why?
¯\\\_(ツ)\_/¯