From 58e8c13a1d429e368e5d1bfb6fb5b93a362f7162 Mon Sep 17 00:00:00 2001 From: Siddharth Dushantha Date: Tue, 19 Feb 2019 18:01:45 +0100 Subject: [PATCH] added usage --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index e27d1aa..974de8d 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,23 @@ Add ```kunst``` to a directory which is in your ```$PATH``` [AUR](https://aur.archlinux.org/packages/kunst-git/) *(maintained by [networkpanic](https://github.com/networkpanic))* +## Usage + +```bash +$ kunst --help +usage: kunst [-h] [--size px] [--music_dir path/to/dir] [--version] + +┬┌─┬ ┬┌┐┌┌─┐┌┬┐ +├┴┐│ ││││└─┐ │ +┴ ┴└─┘┘└┘└─┘ ┴ 1.0 +Download and display album art or display embedded album art + +optional arguments: + -h, --help show this help message and exit + --size what size to display the album art in + --music_dir the music directory which MPD plays from + --version show the version of bum you are using +``` ## License MIT License