diff --git a/README.md b/README.md index 7b186b9..08898a9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ -# tidler +# TiDLer -Tidal music downloader based on the hifi-tui API \ No newline at end of file +*Tidal music downloader based on the hifi-tui API* + +## Requirements +- `jq`, `bash`, `curl` + +## TODO +- Migrate from Bash to a POSIX-compliant shell +- Implement search & download for playlists, albums, and artists +- Support downloading multiple search results +- Allow users to choose audio quality (currently defaults to LOSSLESS) +- Add a configuration file + +## Using +- Download repository: `git clone https://medvidek77.tech/Medvidek77/TiDLer.git && cd TiDLer` +- Add permissions as root: `chmod +x src/tidler` +- Run: `src/tidler` +- Enjoy! :)