Create README.md

2020-12-26 23:44:44 +08:00 · 2020-12-26 23:44:44 +08:00 · 4cdbc35d4a
commit 4cdbc35d4a
parent ec0c11817e
1 changed files with 17 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,17 @@
+# Unlock Music Project - CLI Edition
+Original: Web Edition https://github.com/ix64/unlock-music
+
+## Features
+- [x] All Algorithm Supported By `ix64/unlock-music`
+- [ ] Complete Cover Image
+- [ ] Parse Meta Data
+- [ ] Complete Meta Data
+
+## Hou to Build
+- Requirements: **Golang 1.16**
+
+1. Clone this repo `git clone https://github.com/unlock-music/cli && cd cli`
+2. Build the executable `go build ./cmd/um` 
+
+## How to use
+- Use `./um -h` to show help menu