Skip to content

Commit

Permalink
Bring back the initial disclaimer in README
Browse files Browse the repository at this point in the history
  • Loading branch information
alpsayin committed Dec 12, 2021
1 parent fb461c4 commit 04f449d
Showing 1 changed file with 13 additions and 23 deletions.
36 changes: 13 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
<!--- mdformat-toc start --slug=github --->

<div align="center">
<div align="left">

## What this fork does:

It prepends a track's playlist index (i.e. playlist location) if you're downloading a playlist, album or your saved songs, so you can put then into a dumb mp3 player without losing playlist order.

Readme text is slightly modified to remove install instructions for `dev` and `pipx` versions.
<hr />

</div>

<div align="center">

<img src="/docs/static/logo-transparent.png" alt="spotDL" width="200" />

# spotDL
Expand Down Expand Up @@ -98,8 +109,6 @@ spotDL is being redesigned! This means we are currently not accepting new featur
spotdl --user-auth saved
```

```
- #### To download a playlist, run

```bash
Expand Down Expand Up @@ -277,25 +286,6 @@ spotDL is being redesigned! This means we are currently not accepting new featur
- {ext}
- {playlist}

## `pipx` Isolated Environment Alternative

For users who are not familiar with `pipx`, it can be used to run scripts **without**
installing the spotDL package and all the dependencies globally with pip. (Effectively
skipping over the [spotDL Installation](#Installing-spotDL) step)

First, you will need to install `pipx` by running:

```bash
python3 -m pip install --user pipx
python3 -m pipx ensurepath
```

Next, you can jump directly to running spotDL with:

```bash
pipx run spotdl ...
```

## Contributor Guide

Interested in contributing? Check out our [CONTRIBUTING.md](docs/CONTRIBUTING.md) to find
Expand All @@ -311,7 +301,7 @@ environment.
1. [@ritiek](https://github.com/ritiek) for creating and maintaining spotDL for 4 years
2. [@rocketinventor](https://github.com/rocketinventor) for figuring out YouTube Music
querying
3. [@MikhailZex](https://github.com/MikhailZex) for, never mind...
3. [@MikhailZex](https://github.com/MikhailZex) for, never mind, truly, never mind...

## License

Expand Down

0 comments on commit 04f449d

Please sign in to comment.