From eac369e984fd788edf1778a9349351d7ad48e43a Mon Sep 17 00:00:00 2001 From: Maas Lalani Date: Sun, 31 Oct 2021 11:08:24 -0400 Subject: [PATCH] doc: add installation and usage instructions --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6717f6..a62a825 100644 --- a/README.md +++ b/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. +Ctrl-C or q to exit. #### Why?