dumb/README.md

25 lines
980 B
Markdown
Raw Normal View History

2022-07-02 16:53:14 +00:00
# dumb
2022-10-31 19:39:02 +00:00
With the massive daily increase of useless scripts on Genius's web frontend and having to download megabytes of clutter, [dumb](https://github.com/rramiachraf/dumb) tries to make reading lyrics from Genius a pleasant experience and as lightweight as possible.
2022-07-02 17:12:01 +00:00
![Screenshot](https://raw.githubusercontent.com/rramiachraf/dumb/main/screenshot.png)
2022-07-02 17:10:25 +00:00
2022-10-31 19:39:02 +00:00
## Installation & Usage
[Go 1.18+](https://go.dev/dl) is required.
2022-07-02 16:53:14 +00:00
```bash
2022-07-06 16:06:02 +00:00
git clone https://github.com/rramiachraf/dumb
cd dumb
go build
./dumb
2022-07-02 16:53:14 +00:00
```
The default port is 5555, you can use other ports by setting the `PORT` environment variable.
2022-10-31 19:39:02 +00:00
## Public Instances
2022-10-31 19:42:30 +00:00
As of now, I still haven't got the time to make a public instance and maintain it for people to use at large. For anyone interested in this task feel free to do so and don't forget to create a pull request so I can include your instance here.
2022-10-31 19:39:02 +00:00
## Contributing
2022-10-31 19:42:30 +00:00
Contributions are welcome.
2022-10-31 19:39:02 +00:00
## License
[MIT](https://github.com/rramiachraf/dumb/blob/main/LICENCE)