From e1a76abcb4ea086f68eb39419dde6c141a6ea426 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Mon, 18 Oct 2021 03:58:49 +0200 Subject: [PATCH] Fix formatting and add badges to readme --- .github/ISSUE_TEMPLATE/bug_report.md | 4 +- .github/workflows/rust.yml | 3 +- README.md | 56 ++++++++++++++++------------ 3 files changed, 37 insertions(+), 26 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1609e73..6845a8a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 3d4bf55..5f904ab 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -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 }} diff --git a/README.md b/README.md index 6b28d1e..ed91301 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,22 @@
# DownOnSpot -### A Spotify downloader written in Rust + +A Spotify downloader written in Rust drawing -
+ +
[![Build project](https://github.com/oSumAtrIX/DownOnSpot/actions/workflows/rust.yml/badge.svg)](https://github.com/oSumAtrIX/DownOnSpot/actions/workflows/rust.yml) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4474e5fcc9064562b5d653601ee356f3)](https://www.codacy.com/gh/oSumAtrIX/DownOnSpot/dashboard?utm_source=github.com&utm_medium=referral&utm_content=oSumAtrIX/DownOnSpot&utm_campaign=Badge_Grade) +[![GitHub license](https://img.shields.io/github/license/oSumAtrIX/DownOnSpot)](https://github.com/oSumAtrIX/DownOnSpot/blob/main/LICENSE) +[![GitHub issues](https://img.shields.io/github/issues/oSumAtrIX/DownOnSpot)](https://github.com/oSumAtrIX/DownOnSpot/issues) +[![GitHub forks](https://img.shields.io/github/forks/oSumAtrIX/DownOnSpot)](https://github.com/oSumAtrIX/DownOnSpot/network) +[![GitHub stars](https://img.shields.io/github/stars/oSumAtrIX/DownOnSpot)](https://github.com/oSumAtrIX/DownOnSpot/stargazers) +[![Stability: Experimental](https://masterminds.github.io/stability/experimental.svg)](https://masterminds.github.io/stability/experimental.html) + + ## 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