From 8d3e434539198c01201b9f531f4f5be9f66450b0 Mon Sep 17 00:00:00 2001 From: rramiachraf <51409801+rramiachraf@users.noreply.github.com> Date: Sat, 2 Jul 2022 17:53:14 +0100 Subject: [PATCH] add README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..10e9780 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# dumb +I find myself reading a lot of lyrics while listening to my favorite songs, my go-to place for this is Genius since you can find pretty much everything there, if not you can just create it :D. +My only issue with the platform is their over 4MB of trackers, analytics and junk which has nothing to do with the actual lyrics. +Thus I created this alternative front-end so I can read song lyrics with ease and as lightweight as possible. + +## Install +Go 1.18+ is required. +```bash +go install github.com/rramiachraf/dumb +``` + +## Usage +```bash +dumb +``` +The default port is 5555, you can use other ports by setting the `PORT` environment variable.