From b96482a98566a2633c54c8d9c37f96fa014ffffe Mon Sep 17 00:00:00 2001
From: oskvr37 <oskarxpd@gmail.com>
Date: Sat, 27 Jul 2024 14:42:15 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=80=20update=20for=200.1.0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 43 ++++++++++++++++++++++++++++++++++++++++---
 setup.py  |  2 +-
 2 files changed, 41 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 5e470bd..0cf7e72 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,41 @@
-# TIDDL
+# Tidal Downloader
 
-TIDDL (Tidal Downloader) is a Python CLI application that allows downloading Tidal tracks.
-It's based on [Tidal-Media-Downloader](https://github.com/yaronzz/Tidal-Media-Downloader) and TIDDL is the enhanced version.
\ No newline at end of file
+TIDDL is the Python CLI application that allows downloading Tidal tracks.
+Fully typed, no requirements.
+
+![GitHub top language](https://img.shields.io/github/languages/top/oskvr37/tiddl?style=for-the-badge)
+![PyPI - Version](https://img.shields.io/pypi/v/tiddl?style=for-the-badge)
+[<img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=for-the-badge" />](https://gitmoji.dev)
+
+It's inspired by [Tidal-Media-Downloader](https://github.com/yaronzz/Tidal-Media-Downloader) - currently not mantained project.
+This repository will contain features requests from that project and will be the enhanced version.
+
+# Usage
+
+Install package using `pip`
+
+```bash
+pip install tiddl
+```
+
+After installation use `tiddl`
+
+```bash
+$ tiddl
+⚙️ Go to https://link.tidal.com/CYARD and add device!
+Hit enter when you are ready...
+✅ Token good for 7 days
+Enter track id to download:
+```
+
+You can also use TIDDL as module, it's fully typed so you will get type hints
+
+```python
+from tiddl import TidalApi
+
+api = TidalApi(token, user_id, country_code)
+
+my_playlists = api.getPlaylists()
+
+print(f"You have got {my_playlists['totalNumberOfItems']} playlists!")
+```
diff --git a/setup.py b/setup.py
index 115c291..aef5b6c 100644
--- a/setup.py
+++ b/setup.py
@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="tiddl",
-    version="0.0.1",
+    version="0.1.0",
     description="TIDDL (Tidal Downloader) is a Python CLI application that allows downloading Tidal tracks.",
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',