diff --git a/README.md b/README.md new file mode 100644 index 0000000..03ac327 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# gdead + +Opens grateful dead soundboards and plays them in your terminal. + +## Installation + +```sh +# Download +git clone https://gitea.ksn.gf4/ki9/gdead.git /usr/local/src/gdead +# "Build" +ln -s /usr/local/src/gdead/gdead /usr/local/bin/gdead +``` + +## Usage + +Takes year, month, and day as arguments and plays the top-rated soundboard on [archive.org](https://archive.org/details/GratefulDead). All three args are required. + +```sh +gdead 1969 08 16 +```