add README.md

This commit is contained in:
rramiachraf 2022-07-02 17:53:14 +01:00
parent 58a4755fcf
commit 8d3e434539

16
README.md Normal file
View File

@ -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.