update readme

This commit is contained in:
raziman 2020-06-23 19:27:59 +08:00
parent b1ad3587ce
commit fa1bcb1f70

29
README.md Normal file
View File

@ -0,0 +1,29 @@
# Gomu (Go Music Player)
Gomu is a Terminal User Interface **TUI** that plays your mp3 files in your local directory.
[1]: ./gomu.png "screenshot"
## Features
- lightweight
- show audio files as tree
- simple
## TODO
- [ ] song fade
- [X] delete song from queue
- [ ] bulk add songs to queue
- [ ] download music from youtube
- [ ] audio streaming
- [ ] music change notification
- [ ] volume change notification
- [ ] delete music from filesystem
- [ ] audio seeking
- [ ] loop
- [ ] total queue duration
- [X] read .mp3 file only
- [ ] add support for .wav as well
## Project Background
I just want to implement my own music player with a programming language im currently learning *Go*. Gomu might not be stable as it in constant development. For now, it can do basic music player can do like adding, deleting songs from queue, skip, play, pause but not seeking or more advanced stuff; feel free to contribute :)