Merge branch 'master' of https://github.com/issadarkthing/gomu

README.md

@@ -6,27 +6,29 @@ Gomu is a Terminal User Interface **TUI** that plays your mp3 files in your loca
 
 ## Features
 - lightweight
+- simple
+- fast
 - show audio files as tree
 - vim keybindings
+- youtube-dl integration
+- audio file management
 
 ## Installation
 ```sh
 go get -u github.com/issadarkthing/gomu
 ```
 
-## TODO
+## Configuration
-- [ ] song fade
+By default, gomu will look for audio files in `~/music` directory. If you wish to change to your desired location, edit `~/.config/gomu/config` file
-- [X] delete song from queue
+and change `music_dir: path/to/your/musicDir`. Example of the config file will look like:
-- [x] bulk add songs to queue
+
-- [ ] download music from youtube
+```
-- [ ] audio streaming
+confirm_on_exit: true
-- [x] music change notification
+music_dir: ~/music
-- [x] volume change notification
+confirm_bulk_add: true
-- [ ] delete music from filesystem
+popup_timeout: 5
-- [ ] audio seeking
+```
-- [ ] loop
+
-- [ ] total queue duration
-- [ ] add support for .wav as well
 
 
 ## Project Background