confetty/README.md

42 lines
637 B
Markdown
Raw 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">
2022-06-28 11:57:00 -07:00
<img src="./assets/confetty.gif?raw=true" alt="Confetti in your TTY" />
2022-03-23 21:28:29 -07:00
</p>
2021-08-06 21:03:32 -07:00
2021-12-07 19:09:15 -08:00
### Preview
2022-03-23 21:32:55 -07:00
You can preview `confetty` through `ssh` (thanks to [charmbracelet/wish](https://github.com/charmbracelet/wish))
2021-12-07 19:09:15 -08:00
```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.
2021-08-06 21:03:32 -07:00
#### Why?
2021-08-06 21:05:50 -07:00
¯\\\_(ツ)\_/¯