mirror of
https://github.com/maaslalani/confetty.git
synced 2024-11-14 11:46:43 +00:00
doc: add installation and usage instructions
This commit is contained in:
parent
e6b98c8559
commit
eac369e984
21
README.md
21
README.md
@ -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?
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user