confetty/README.md

44 lines
672 B
Markdown
Raw Permalink Normal View History

2022-03-23 21:32:55 -07:00
# Confetty
Confetti (or fireworks) inside your terminal.
2022-02-24 21:52:30 -08:00
2022-03-23 21:28:29 -07:00
<p align="center">
<img src="confetty.gif" alt="Confetti in your TTY" />
2022-03-23 21:28:29 -07:00
</p>
2021-08-06 21:03:32 -07:00
<p align="center">
<img src="fireworks.gif" alt="Fireworks in your TTY" />
</p>
2021-12-07 19:09:15 -08:00
### Installation
2021-12-07 19:09:15 -08:00
2022-11-05 12:08:56 -07:00
```bash
go install github.com/maaslalani/confetty@latest
2021-12-07 19:09:15 -08:00
```
### Preview
Get `confetty` in your terminal without installing through SSH.
2022-11-05 12:08:56 -07:00
```bash
ssh -p 2222 ssh.caarlos0.dev # Confetti
ssh -p 2223 ssh.caarlos0.dev # Fireworks
```
### Usage
2022-11-05 12:08:56 -07:00
```bash
confetty
```
2022-11-05 12:08:56 -07:00
```bash
confetty fireworks
```
Press any key to cause more confetti / fireworks to appear.
<kbd>Ctrl-C</kbd> or <kbd>q</kbd> to exit.
2021-08-06 21:03:32 -07:00
#### Why?
2021-08-06 21:05:50 -07:00
¯\\\_(ツ)\_/¯