Update document

This commit is contained in:
kokarare1212 2021-05-16 08:11:54 +09:00
parent 340e3dbbcb
commit e578e6570d
1 changed files with 12 additions and 12 deletions

View File

@ -7,22 +7,22 @@
* [Supported Futures](supported.md)
* [API Reference](api.md)
## What's librespot-python?
librespot-python is a python port of Spotify's open source client library [librespot](https://github.com/librespot-org/librespot).
It was created to play Spotify on various platforms and devices.
| librespot-python is a python port of Spotify's open source client library [librespot](https://github.com/librespot-org/librespot).
| It was created to play Spotify on various platforms and devices.
## What do you need?
In order to develop with this library, you need to use Python.
Python can be downloaded from [the official website here](https://python.org/).
| In order to develop with this library, you need to use Python.
| Python can be downloaded from [the official website here](https://python.org/).
## Disclaimer
Please keep in mind that this library is not like Spotify approved.
Therefore, the worst that can happen is that you will be banned from Spotify.
Also, please keep in mind that this library is in alpha and may behave in unintended ways.
| Please keep in mind that this library is not like Spotify approved.
| Therefore, the worst that can happen is that you will be banned from Spotify.
| Also, please keep in mind that this library is in alpha and may behave in unintended ways.
## Installation
You can download this library in the following way.
Stable Version ***still not working.**
| You can download this library in the following way.
| Stable Version ***still not working.**
```commandline
pip install librespot
```
Snapshot Version ***Recommended**
| Snapshot Version ***Recommended**
```commandline
pip install git+https://github.com/kokarare1212/librespot-python
```
@ -39,7 +39,7 @@ session = Session.Builder() \
aceess_token = session.tokens().get("playlist-read")
```
### Get Music Stream
*Currently, music streaming is supported, but it may cause unintended behavior.
| *Currently, music streaming is supported, but it may cause unintended behavior.
```python
from librespot.core import Session
from librespot.metadata import TrackId
@ -56,7 +56,7 @@ stream = session.content_feeder().load(track_id, VorbisOnlyAudioQuality(AudioQua
# ex: 1 (If there is no more voice data, -1 is received as the result.)
```
## Debug
To display the debug information, you need to inject the following code at the top of the code.
| To display the debug information, you need to inject the following code at the top of the code.
```python
import logging