mirrors
/
confetty
mirror of https://github.com/maaslalani/confetty.git
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add installation and usage instructions

This commit is contained in:
Maas Lalani 2021-10-31 11:08:24 -04:00
parent e6b98c8559
commit eac369e984
No known key found for this signature in database
GPG Key ID: F53774FA051C052A
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,7 +1,26 @@
# ConfeTTY
https://user-images.githubusercontent.com/42545625/128612977-5d6e0321-9584-48b5-8ff8-dd5b811211d3.mov
Confetti inside your terminal.
Confetti (or fireworks) inside your terminal.
### 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?