Fix formatting and add badges to readme
This commit is contained in:
parent
bead5bf2dc
commit
e1a76abcb4
3 changed files with 37 additions and 26 deletions
4
.github/ISSUE_TEMPLATE/bug_report.md
vendored
4
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
|
|||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
|
|
@ -24,7 +25,8 @@ A clear and concise description of what you expected to happen.
|
|||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
|
||||
- OS: [e.g. iOS]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
|
|
|||
3
.github/workflows/rust.yml
vendored
3
.github/workflows/rust.yml
vendored
|
|
@ -17,10 +17,9 @@ jobs:
|
|||
build_and_test:
|
||||
name: DownOnSpot
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- run: sudo apt install -y libasound2-dev libmp3lame-dev
|
||||
- run: sudo apt install -y libasound2-dev libmp3lame-dev
|
||||
- uses: webfactory/ssh-agent@v0.5.3
|
||||
with:
|
||||
ssh-private-key: ${{ secrets.FREE_LIBRESPOT_PRIVATE_KEY }}
|
||||
|
|
|
|||
56
README.md
56
README.md
|
|
@ -1,12 +1,22 @@
|
|||
<div align="center">
|
||||
|
||||
# DownOnSpot
|
||||
### A Spotify downloader written in Rust
|
||||
|
||||
A Spotify downloader written in Rust
|
||||
|
||||
<img src="assets/icon.svg" alt="drawing" width="500"/>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
|
||||
[](https://github.com/oSumAtrIX/DownOnSpot/actions/workflows/rust.yml)
|
||||
[](https://www.codacy.com/gh/oSumAtrIX/DownOnSpot/dashboard?utm_source=github.com&utm_medium=referral&utm_content=oSumAtrIX/DownOnSpot&utm_campaign=Badge_Grade)
|
||||
[](https://github.com/oSumAtrIX/DownOnSpot/blob/main/LICENSE)
|
||||
[](https://github.com/oSumAtrIX/DownOnSpot/issues)
|
||||
[](https://github.com/oSumAtrIX/DownOnSpot/network)
|
||||
[](https://github.com/oSumAtrIX/DownOnSpot/stargazers)
|
||||
[](https://masterminds.github.io/stability/experimental.html)
|
||||
|
||||
</div>
|
||||
|
||||
## Disclaimer
|
||||
|
||||
|
|
@ -18,13 +28,13 @@ I am not responsible in any way for the usage of the source code.
|
|||
|
||||
## Features
|
||||
|
||||
- Works with free Spotify accounts (if using free-librespot fork)
|
||||
- Download 96, 160, 256kbit/s audio with a free and 320 kbit/s audio with a premium account from Spotify, directly
|
||||
- Multi-threaded
|
||||
- Download tracks, playlists, albums and artists
|
||||
- Convert to mp3
|
||||
- Metadata tagging
|
||||
- Simple usage over CLI
|
||||
- Works with free Spotify accounts (if using free-librespot fork)
|
||||
- Download 96, 160, 256kbit/s audio with a free and 320 kbit/s audio with a premium account from Spotify, directly
|
||||
- Multi-threaded
|
||||
- Download tracks, playlists, albums and artists
|
||||
- Convert to mp3
|
||||
- Metadata tagging
|
||||
- Simple usage over CLI
|
||||
|
||||
## Building
|
||||
|
||||
|
|
@ -73,26 +83,26 @@ down_on_spot.exe (track_url | album_url | playlist_url | artist_url)
|
|||
|
||||
Following variables are available for `path` and `filename_template` in the `settings.json`:
|
||||
|
||||
- %0disc%
|
||||
- %0track%
|
||||
- %album%
|
||||
- %albumArtist%
|
||||
- %albumArtists%
|
||||
- %artist%
|
||||
- %disc%
|
||||
- %id%
|
||||
- %title%
|
||||
- %track%
|
||||
- %0disc%
|
||||
- %0track%
|
||||
- %album%
|
||||
- %albumArtist%
|
||||
- %albumArtists%
|
||||
- %artist%
|
||||
- %disc%
|
||||
- %id%
|
||||
- %title%
|
||||
- %track%
|
||||
|
||||
## Known issues
|
||||
|
||||
- Downloads often slow
|
||||
- Downloads fail sometimes due to `channel error`
|
||||
- Downloads often slow
|
||||
- Downloads fail sometimes due to `channel error`
|
||||
|
||||
## Authors
|
||||
|
||||
- [@oSumAtrIX](https://osumatrix.me/#github)
|
||||
- [@exttex](https://git.freezer.life/exttex)
|
||||
- [@oSumAtrIX](https://osumatrix.me/#github)
|
||||
- [@exttex](https://git.freezer.life/exttex)
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue