From c42db8f494eb222ca7e95951f4bf3e01e5986c76 Mon Sep 17 00:00:00 2001 From: DaveHealS <114851206+DaveHealS@users.noreply.github.com> Date: Wed, 25 Sep 2024 19:17:02 -0400 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index cac4e49..7bd2bf8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ # Spotify Deduplicator +A quick and easy way of tidying up your Spotify playlists. [![Greenkeeper badge](https://badges.greenkeeper.io/JMPerez/spotify-dedup.svg)](https://greenkeeper.io/) [![GitHub issues](https://img.shields.io/github/issues/JMPerez/spotify-dedup)](https://github.com/JMPerez/spotify-dedup/issues) +## Table of Contents ## Table of Contents 1. [Introduction](#introduction) 2. [Features](#features) 3. [Usage](#usage) 4. [Installation](#installation) + - [Using pnpm (recommended)](#using-pnpm-recommended) + - [Using npm or yarn](#using-npm-or-yarn) 5. [Testing](#testing) 6. [About the Tools Used](#about-the-tools-used-and-implementation-details) - [Spotify Web API and Promises](#spotify-web-api-and-promises) @@ -27,24 +31,30 @@ Have you ever wanted to remove duplicated songs from your Spotify library? Now y ## Usage -You can check it out on [https://spotify-dedup.com](https://spotify-dedup.com) or run it locally. -1. Login with your Spotify account. -2. Once logged in, your playlists and liked songs will automatically be scanned. -3. Review detected duplicates for each playlist. -4. Remove all duplicates in one playlist by clicking the removal button. +Here is a quick guide on how to use Spotify-Dedup: +1. Visit the website on [https://spotify-dedup.com](https://spotify-dedup.com) (or your local version). +2. Login with your Spotify account. The website will remember previous spotify logins if you use this tool multiple times without clearing your browsers cache. +3. Once logged in, your playlists and liked songs will automatically be scanned for duplicate songs. +4. Review detected duplicates for each playlist. +5. Remove all duplicates in one playlist by clicking the removal button. The first instance of each song will stay in your playlist. + -Scan results +###Scan results ![image](https://github.com/user-attachments/assets/291641a6-49f3-40b7-924e-f59b6ae5c518) -After deduping +###After deduping ![image](https://github.com/user-attachments/assets/4e4a6f82-cb39-449f-a39b-6f2f7519e03d) +If you have further questions, check the ["Frequently asked questions"-section on the website](https://spotify-dedup.com/). + ## Installation -You will need NPM and therefore Node.js installed for this project. Check the [installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for NPM. +### Using pnpm (recommended) -Also, ensure you have **pnpm** installed. If you don't have it, install it using the following gcommand: +Using pnpm is recommended for installing this project. pnpm can easily be installed with npm. If you don't have npm installed, check out the [installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for NPM. + +To install the project, ensure you have **pnpm** installed. If you don't have it, install it using the following command: npm install -g pnpm @@ -60,6 +70,10 @@ Run it locally: Then, open your browser and navigate to http://localhost:3000. +### Using npm or yarn: + +Instructions for npm or yarn can be found on their respective websites. The basic steps are similar to using pnpm. + ## Testing In order to test saved tracks, create duplicated tracks by executing the Web API request on https://developer.spotify.com/console/put-current-user-saved-tracks/?ids=2JZfTvWWtpaE8NohqRXqFr,1poUtf2dDdVUtWL8tn03Wd,6ADSaE87h8Y3lccZlBJdXH,2x45xqISlmmDJqxOqr8BuS,1iQ1BpOGF1Umd3lpTV4OPO.