From d2341e1bd2f8e568224574495bbaf45308da7b16 Mon Sep 17 00:00:00 2001 From: geo-martino Date: Thu, 11 Jan 2024 15:27:14 -0500 Subject: [PATCH] actually update the readme --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4d7b932c..61ebdec1 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,10 @@ * [Quick Start](#quick-start) * [Spotify](#quick-start-spotify) * [Local](#quick-start-local) - * [Local](#quick-start-local) -* [Currently Supported](#currenty-supported) + * [Sync local and remote](#quick-start-sync) +* [Currently Supported](#supported) +* [Motivation & Aims](#aims) +* [Author Notes](#notes) ## Installation Package is listed on PyPI and can be installed as usual through pip. @@ -33,6 +35,7 @@ pip install syncify python -m pip install syncify ``` + ## Quick Start > [!TIP] @@ -329,7 +332,7 @@ python -m pip install syncify ``` 3. Load the matched tracks, get tags from the music streaming service, and save the tags to the file: - > **NOTE**: By default, URIs are saved to the `c` `o` `m` `m` `e` `n` `t` `s` tag. + > **NOTE**: By default, URIs are saved to the `comments` tag. ```python from syncify.spotify.object import SpotifyTrack @@ -368,16 +371,16 @@ python -m pip install syncify print(remote_playlist) ``` - + ## Currently Supported - **Music Streaming Services**: `Spotify` -- **Audio filetypes**: `.mp3` `.wma` `.flac` `.m4a` -- **Local playlist filetypes**: `.m3u` `.xautopf` +- **Audio filetypes**: `.wma` `.flac` `.mp3` `.m4a` +- **Local playlist filetypes**: `.xautopf` `.m3u` - **Local Libraries**: `MusicBee` - -## Motivations and aims + +## Motivations & Aims The key aim of this package is to provide a seamless framework for interoperability between all types of music libraries whether local or remote.
@@ -411,7 +414,7 @@ and instead return to a culture of nurturing talent by providing artists with a on the work of their craft. One can dream. - + ## Author notes, contributions, and reporting issues I initially developed this program for my own use so that I can share my local playlists with friends online.