Dev to Master (#1151)

* Fix workflows (#1133)
Author: @Silverarmor 


* New PR Template & Update stalebot configs (#1118)
Author: @Silverarmor 


* Installation guide. (#1137)
Authors: @commanderabdu & @Silverarmor 
Co-authored-by: Silverarmor <23619946+Silverarmor@users.noreply.github.com>


* Add script to setup spotdl on termux (#1153)
Author: @s1as3r 

* Align logo to the right in readme (#1152)
Author: @jcs090218 




Co-authored-by: commanderabdu <73636685+commanderabdu@users.noreply.github.com>
Co-authored-by: Arbaaz Shafiq <62838200+s1as3r@users.noreply.github.com>
Co-authored-by: Jen-Chieh Shen <jcs090218@gmail.com>

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,11 @@
-<!--- PLEASE REMEMBER TO ADD THE "BUGFIX" OR "ENHANCEMENT" LABEL TO YOUR PR -->
+🚨 Please review our [guidelines for contributing](https://github.com/spotDL/spotify-downloader/blob/master/CONTRIBUTING.md) and [core values](https://github.com/spotDL/spotify-downloader/blob/master/Design%20Docs/CORE%20VALUES.md)
 
+## Description
+<!--- Describe your changes. Please be concise and specific. -->
 
-## Design
-<!--- Describe the problem or feature in addition to a link to the issues. -->
-
-## Approach
-<!--- Describe your solution in around 50 words. Please be concise and specific. -->
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
 

.github/stale.yml

@@ -6,8 +6,8 @@ daysUntilClose: 7
 
 # Issues with these labels will never be considered stale
 exemptLabels:
-  - feature-under-consideration
-  - next-rel-dev
+  - META
+  - High Priority
 
 # Label to use when marking an issue as stale
 staleLabel: stale
@@ -18,5 +18,4 @@ markComment: >
   any activity for the last 30 days.
 
 # Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: >
-  This issue is being closed as it has been 'stale' for a week now.
+closeComment: false

.github/workflows/python-publish.yml

@@ -6,7 +6,6 @@ name: Upload Python Package
 on:
   release:
     types: 
-      - created
       - published
 
 jobs:

.github/workflows/spotify-downloader-ci.yml

@@ -3,11 +3,7 @@
 
 name: spotify-downloader-ci
 
-on:
-  push:
-    branches: [ master, dev ]
-  pull_request:
-    branches: [ master, dev ]
+on: [push, pull_request]
 
 jobs:
   test:

.gitignore

@@ -7,7 +7,15 @@
 # Python
 __pycache__
 .mypy_cache
+
+# Environments
+.env
 .venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
 
 # vscode
 .vscode

INSTALLATION.md

@@ -0,0 +1,65 @@
+# spotDL Installation Guide
+
+spotDL is a free and open source tool that downloads your Spotify playlists & music
+> **The fastest, easiest, and most accurate command-line music downloader**
+
+## Prerequisites
+
+- Python (added to PATH)
+- FFmpeg (added to PATH)
+
+### Adding Python to PATH
+
+When installing Python, ensure to select "**Add to PATH**".
+
+![Add to PATH Image](static/ADD_TO_PATH.png)
+
+### Installing FFmpeg
+
+- [Windows Tutorial](https://windowsloop.com/install-ffmpeg-windows-10/)
+- OSX - `brew install ffmpeg`
+- Linux - `sudo snap install ffmpeg`
+
+### Verifying Versions
+
+`py -V` - Should return "Python 3.X.X". Please ensure you have v3.6.X or greater.
+
+`FFmpeg -version` - Should return starting with "ffmpeg version YYYY-MM-DD"
+
+## Installing spotDL
+
+You can install spotDL by opening a terminal and typing:
+
+```shell
+pip install spotdl
+```
+
+If you encounter errors, our `hotfix` branch may be able to help you:
+
+1. `pip install pip-autoremove`
+2. `pip-autoremove spotdl`
+3. `pip cache purge`
+4. `pip install https://codeload.github.com/spotDL/spotify-downloader/zip/hotfix`
+
+If you require further help, ask in our [Discord Server](https://discord.gg/xCa23pwJWY)
+
+[![Discord Server](https://img.shields.io/discord/771628785447337985?color=7289da&label=DISCORD&style=for-the-badge)](https://discord.gg/xCa23pwJWY)
+
+## Where does spotDL download songs?
+
+spotDL downloads files to the folder where you ran spotDL from.
+
+Open pwsh/powershell/cmd/terminal/similar in the folder you want files to download to, or cd to desired folder.
+
+**Windows Shortcut:** Navigate to the folder you want the files to download to. `SHIFT + RIGHT CLICK`, then select "Open PowerShell window here"
+
+![Windows PWSH](static/POWERSHELL.png)
+
+## We have a public Discord server at **[discord.gg/xCa23pwJWY](https://discord.gg/xCa23pwJWY)!**
+
+[![Discord Server](https://img.shields.io/discord/771628785447337985?color=7289da&label=DISCORD&style=for-the-badge)](https://discord.gg/xCa23pwJWY)
+
+## Installation Guide Authors
+
+- Initial Draft - [@commanderabdu](https://github.com/commanderabdu) - NoSubwayzz
+- Editing & Updating - [@Silverarmor](https://github.com/Silverarmor)

README.md

@@ -1,5 +1,4 @@
-![logo](static/logo.png)
-
+<a href="https://github.com/spotDL/spotify-downloader"><img align="right" src="static/logo-transparent.png" alt="logo" width="253" height="116"/></a>
 # spotDL
 
 > **The fastest, easiest, and most accurate command-line music downloader**
@@ -59,6 +58,12 @@ You need to download FFmpeg to use this tool. Download and installation instruct
   $ pip install https://codeload.github.com/spotDL/spotify-downloader/zip/dev
   ```
 
+#### On Termux:
+
+  ```
+  curl https://github.com/spotDL/spotify-downloader/raw/master/termux/setup_spotdl.sh | sh
+  ```
+
 ___YouTube Music must be available in your country for spotDL to work. This is because we use YouTube Music to filter search results. You can check if YouTube Music is available in your country, by visiting [YouTube Music](https://music.youtube.com).___
 
 ## Usage (Instructions for v3)

termux/setup_spotdl.sh

@@ -0,0 +1,11 @@
+# setup-storage
+termux-setup-storage
+
+# update packages
+pkg update
+
+# install python and ffmpeg
+pkg install python ffmpeg
+
+# install spotdl
+pip install -U spotdl