From 9ff398e3bc4a11cdcce024c82230a6a1f847dff8 Mon Sep 17 00:00:00 2001
From: Lars Noack <lars.noack@outlook.de>
Date: Tue, 15 Nov 2022 10:52:54 +0100
Subject: [PATCH] documenting the use of the tool

---
 README.md      | 33 +++++++++++++++++++++++++++++++--
 pyproject.toml |  2 +-
 2 files changed, 32 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 5633fed..d44ffdf 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,37 @@
 # Music Kraken
 
-RUN WITH: `python3 -m src` from the project Directory
+## Installation
 
-This programm will first get the metadata of various songs from metadata provider like musicbrainz, and then search for download links on pages like bandcamp. Then it will download the song and edit the metadata according.
+You can find this project on PyPI [https://pypi.org/project/music-kraken/](https://pypi.org/project/music-kraken/) or GitHub [https://github.com/HeIIow2/music-downloader](https://github.com/HeIIow2/music-downloader). If you enjoy this project, feel free to star it.
+
+```sh
+# install it with
+pip install music-kraken
+
+# and run it with (the -m is important)
+python3 -m music_kraken
+```
+
+## Quick-Guide
+
+**Genre:** First the cli asks you to input a gere you want to download to. The options it gives you (if it gives you any) are all the folders you got in the music directory. You also can just input a new one.
+
+**What to download:** After that it prompts you for a search. Here are a couple examples how you can search:
+
+```
+> #a Psychonaut 4
+searches for the artist "Psychonaut 4"
+
+> #a Crystal F #r das Leben dannach
+searches for the release (album) "das Leben dannach" by the artist "Crystal F"
+
+> #r Death Pierce Me #t sterile nails and thunderbowels
+searches for the track "sterile nails and thunderbowels" from the release "Death Pierce Me"
+```
+
+After searching with this syntax it prompts you with multiple results. You can either choose one of those by inputing its id `int` or you can search for a new query.
+
+After you chose either an artist, a release group, a release or a track by its id, download it by inputing the string `ok`. My downloader will download it automatically for you.
 
 ## Metadata
 
diff --git a/pyproject.toml b/pyproject.toml
index 5aa7e27..4fc72c1 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "music_kraken"
-version = "0.0.7"
+version = "0.0.8"
 authors = [
   { name="Hellow2", email="Hellow2@outlook.de" },
 ]