spotDL · Dec 22, 2020 · Oct 19, 2020 · Oct 30, 2020 · Nov 24, 2020 · Nov 30, 2020
diff --git a/.gitignore b/.gitignore
@@ -7,6 +7,7 @@
 # Python
 __pycache__
 .mypy_cache
+.venv
 
 # vscode
 .vscode

diff --git a/README.md b/README.md
@@ -1,106 +1,159 @@
+![logo](static/logo.png)
+
 # spotDL
 
-[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/spotDL/spotify-downloader/blob/master/LICENSE)
+> The fastest, easiest, and most accurate command-line music downloader
 
-⚠ Interested Contributors, please read our [contributing Guidelines](CONTRIBUTING.md) first.
+[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/spotDL/spotify-downloader/blob/master/LICENSE) ![Contributors](https://img.shields.io/github/contributors/spotDL/spotify-downloader) ![downloads](https://img.shields.io/github/downloads/spotDL/spotify-downloader/latest/total) 
+[![pypi version](https://img.shields.io/pypi/v/spotDL)](https://pypi.org/project/spotdl/) [![pypi version](https://img.shields.io/pypi/pyversions/spotDL)](https://pypi.org/project/spotdl/) [![pypi downloads](https://img.shields.io/pypi/dw/spotDL?label=downloads@pypi)](https://pypi.org/project/spotdl/) 
 
-⚠ We are dropping active development of spotDL v2. No focused efforts will be made to resolve v2
-specific issues.
 
-⚠ We are actively looking for Contributors/Organization Members for all projects under development. 
-If interested, see [#857](https://github.com/spotDL/spotify-downloader/issues/857)
+What spotDL does:
+1. Downloads music from YouTube as an MP3 file
+2. Applies basic metadata such as:
+    - Track Name
+    - Track Number
+    - Album
+    - Album Cover
+    - Genre
+    - and more!
 
-⚠ There are a few feature requests we'd like the community to vote on. Do voice your support for features you'd like.
-See [#867](https://github.com/spotDL/spotify-downloader/issues/867) to vote.
 
-<br><br>
+### Announcing spotDL v3
 
-What spotDL does:
-1. Downloads music from YouTube as an MP3 file
-2. Applies basic metadata like `track name`, `track number`, `album`, `genre` and more...
+We rebuilt spotDL from scratch to be much faster, simpler, and better than the old spotDL.
+he documentation is also a work in progress. v3.0.2 is yet to be released to PyPi so you can't install it using `pip`, this is intentional. v3.0.2 is still in alpha testing. We request that you use spotDL v3 and submit issues to voice problems and like-to-haves that you come across.
 
-<br><br>
+#### Please Read
 
-You need to download ffmpeg to use this tool, download it from:
-1. [MacOs](https://evermeet.cx/ffmpeg/)
-2. [Windows](https://www.gyan.dev/ffmpeg/builds/)
-3. [Linux](https://johnvansickle.com/ffmpeg/)
-4. [Central Release Page](https://ffmpeg.org/download.html)
+⚠ We have dropped active development of spotDL v2 due to support and organization changes. No focused efforts will be made to resolve v2 specific issues.
 
-<br><br>
+⚠ We are actively looking for Contributors/Organization Members for all projects under development. If interested, please read our [Contributing Guidelines](CONTRIBUTING.md) first and see [#857](https://github.com/spotDL/spotify-downloader/issues/857)
 
-# Announcing spotDL v3.0.2
+⚠ There are a few feature requests we'd like the community to vote on. Do voice your support for features you'd like. See [#867](https://github.com/spotDL/spotify-downloader/issues/867) to vote.
 
-We have rebuilt spotDL from scratch to be much faster, simpler and better than the old spotDL.
-The documentation for the same is a work in progress. v3.0.2 is yet to be released to PyPi so you
-can't install it using `pip`, this is intentional. v3.0.2 is still in alpha testing. We request that
-you use spotDL v3 and open issues for problems that you come across.
+<br/>
 
-# Installation
+## Installation
 
-1. For stable version
+You need to download FFmpeg to use this tool. Download and installation instructions can be found at [FFmpeg.org](https://ffmpeg.org/)
+
+
+- Recommended Stable Version:
 
     ```
-    $pip install spotdl
+    $ pip install spotdl
     ```
 
-2. For latest version (not necessarily stable)
+- Alternatively, for the latest version (not necessarily stable):
 
     ```
-    $pip install https://github.com/spotDL/spotify-downloader/archive/next-rel-dev.zip
+    $ pip install https://github.com/spotDL/spotify-downloader/archive/next-rel-dev.zip
     ```
-
-3. Voila !
 
-# How to use (instructions for v3)
-To download a song run,
+*The availability of YouTube Music in your country is important for spotDL to work since we use YouTube Music to filter out our search results. To check if YouTube Music is available in your country, visit [YouTube Music](https://music.youtube.com).*
 
-    # spotdl $trackUrl
-    spotdl https://open.spotify.com/track/08mG3Y1vljYA6bvDt4Wqkj?si=SxezdxmlTx-CaVoucHmrUA
 
-To download an album run,
-
-    # spotdl $albumUrl
-    spotdl https://open.spotify.com/album/2YMWspDGtbDgYULXvVQFM6?si=gF5dOQm8QUSo-NdZVsFjAQ
+## Usage (instructions for v3)
 
-To download a playlist run,
-
-    # spotdl $playlistUrl
-    spotdl https://open.spotify.com/playlist/37i9dQZF1DWXhcuQw7KIeM?si=xubKHEBESM27RqGkqoXzgQ
+- To download a song, run:
 
-To search for and download a song (not very accurate) run,
-
-    # spotdl $songQuery
-    spotdl 'The HU - Sugaan Essenna'
+    ```
+    $ spotdl [trackUrl]
+    ```
+    ex. `spotdl https://open.spotify.com/track/08mG3Y1vljYA6bvDt4Wqkj?si=SxezdxmlTx-CaVoucHmrUA`
+    <br/>
 
-To resume a failed/incomplete download run,
-
--   ```
-    # spotdl $pathToTrackingFile
-    spotdl 'Sugaan Essenna.spotdlTrackingFile'
+- To download an album, run:
+
+    ```
+    $ spotdl [albumUrl]
+    ```
+    ex. `spotdl https://open.spotify.com/album/2YMWspDGtbDgYULXvVQFM6?si=gF5dOQm8QUSo-NdZVsFjAQ`
+    <br/>
+
+- To download a playlist, run:
+
+    ```
+    $ spotdl [playlistUrl]
+    ```
+    ex. `spotdl https://open.spotify.com/playlist/37i9dQZF1DWXhcuQw7KIeM?si=xubKHEBESM27RqGkqoXzgQ`
+    <br/>
+
+- To search for and download a song, run (with quotation marks):
+    *(Note: This may not be very accurate)*
+
+    ```
+    $ spotdl '[songQuery]'
     ```
+    ex. `spotdl 'The HU - Sugaan Essenna'`
+
+    <br/>
 
--   Note, '.spotDlTrackingFiles' are automatically created during download start, they are deleted on
-    download completion
+- To resume a failed/incomplete download, run:
 
-You can chain up download tasks by seperating them with spaces:
+    ```
+    $ spotdl [pathToTrackingFile]
+    ```
+    ex. `spotdl 'Sugaan Essenna.spotdlTrackingFile'`
 
-    # spotdl $songQuery1 $albumUrl $songQuery2 ... (order does not matter)
-    spotdl 'The Hu - Sugaan Essenna' https://open.spotify.com/playlist/37i9dQZF1DWXhcuQw7KIeM?si=xubKHEBESM27RqGkqoXzgQ ...
+    *`.spotDlTrackingFiles` are automatically created when a download starts, and deleted on completion*
+
+<br/>
+
+You can queue up multiple download tasks by separating the arguments with spaces:
+
+```
+$ spotdl [songQuery1] [albumUrl] [songQuery2] ... (order does not matter)
+```
+ex. `spotdl 'The Hu - Sugaan Essenna' https://open.spotify.com/playlist/37i9dQZF1DWXhcuQw7KIeM?si=xubKHEBESM27RqGkqoXzgQ ...`    
+
+<br/>
 
-Spotdl downloads up to 4 songs in parallel - try to download albums and playlists instead of
-tracks for more speed.
+*spotDL downloads up to 4 songs in parallel, so try to download albums and playlists, instead of tracks for a faster experience.*
 
-# Note
 
-The availability of YouTube Music in your country is important for spotDL to work since we use YouTube Music to filter out our search results.
-To check if YouTube Music is available in your country, visit [YouTube Music](https://music.youtube.com).
+## For Developers and Contributors
+
+1. Clone this repository
+    ```
+    $ git clone https://github.com/spotDL/spotify-downloader.git
+    $ cd spotify-downloader
+    ```
+2. Install requirements
+    - Windows
+        ```
+        $ py -3 -m venv env
+        $ .\.venv\Scripts\activate
+        (.venv)$ python setup.py develop
+        ```
+    - Linux/macOS
+      ```
+      $ python3 -m venv .venv
+      $ source .venv/bin/activate
+      (.venv)$ python setup.py develop
+      ```
+-  Use as Command (no need to re-install after file changes)
+    ```
+    (.venv)$ spotdl [ARGUMENTS]
+    ```
+-  Use as Library
+    ```
+    (.venv)$ python
+    >>> import spotdl
+    >>> ...
+    ```
+- Cleaning Up
+    ```
+    (.venv)$ deactivate
+    ```
+
 
-# Thanks for developing the v3.0.1
+## Thanks for developing v3.0.1
 1. [@ritiek](https://github.com/ritiek) for creating and maintaining spotDL for 4 years
-2. [@rocketinventor](https://github.com/rocketinventor) for figuring out the YouTube Music querying
+2. [@rocketinventor](https://github.com/rocketinventor) for figuring out YouTube Music querying
 3. [@Mikhail-Zex](https://github.com/Mikhail-Zex) for, never mind...
 
-# A few interesting forks
+## A few interesting forks
 1. [aasmpro/spotify/downloader](https://github.com/aasmpro/spotify-downloader)
     - Sets metadata for songs that are already downloaded (v2 only.)
diff --git a/static/logo.png b/static/logo.png