From 836be67d7de7d0ab1f09d0e6ebb4678a8425697e Mon Sep 17 00:00:00 2001
From: trueold89 <trueold89@orudo.ru>
Date: Thu, 21 Mar 2024 07:57:09 +0300
Subject: [PATCH] Add README.md

---
 README.md | 20 ++++++++++++++++++++
 setup.py  |  1 +
 2 files changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89a6c4f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# SpotifyLinuxOpen
+
+#### A simple cli-utility that allows you to open "open.spotify.com" in the Spotify desktop client on Linux
+
+## Usage:
+**Link:** `https://open.spotify.com/<type>/<id>`
+```shell
+slopen https://open.spotify.com/track/4PTG3Z6ehGkBFwjybzWkR8?si=a4ec356b33fd49d3
+```
+
+## Build:
+
+**Build python pkg**
+```shell
+pip install setuptools && python setup.py
+```
+**Install**
+```shell
+pip install dist/*
+```
diff --git a/setup.py b/setup.py
index 07e15d7..1a5d2a2 100644
--- a/setup.py
+++ b/setup.py
@@ -8,6 +8,7 @@ setup(
     author_email='trueold89@orudo.ru',
     description="A simple cli-utility that allows you to open 'open.spotify.com' in the Spotify desktop client on Linux",
     packages=['sllo'],
+    long_description=open('README.md').read(),
     entry_points={
         "console_scripts": ["slopen = sllo.Main:main"]
     }