Skip to content

Commit c42db8f

Browse files
authored
Update README.md
1 parent bbd7800 commit c42db8f

1 file changed

Lines changed: 23 additions & 9 deletions

File tree

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# Spotify Deduplicator
2+
A quick and easy way of tidying up your Spotify playlists.
23

34
[![Greenkeeper badge](https://badges.greenkeeper.io/JMPerez/spotify-dedup.svg)](https://greenkeeper.io/)
45
[![GitHub issues](https://img.shields.io/github/issues/JMPerez/spotify-dedup)](https://github.com/JMPerez/spotify-dedup/issues)
56

7+
## Table of Contents
68
## Table of Contents
79
1. [Introduction](#introduction)
810
2. [Features](#features)
911
3. [Usage](#usage)
1012
4. [Installation](#installation)
13+
- [Using pnpm (recommended)](#using-pnpm-recommended)
14+
- [Using npm or yarn](#using-npm-or-yarn)
1115
5. [Testing](#testing)
1216
6. [About the Tools Used](#about-the-tools-used-and-implementation-details)
1317
- [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
2731

2832
## Usage
2933

30-
You can check it out on [https://spotify-dedup.com](https://spotify-dedup.com) or run it locally.
31-
1. Login with your Spotify account.
32-
2. Once logged in, your playlists and liked songs will automatically be scanned.
33-
3. Review detected duplicates for each playlist.
34-
4. Remove all duplicates in one playlist by clicking the removal button.
34+
Here is a quick guide on how to use Spotify-Dedup:
35+
1. Visit the website on [https://spotify-dedup.com](https://spotify-dedup.com) (or your local version).
36+
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.
37+
3. Once logged in, your playlists and liked songs will automatically be scanned for duplicate songs.
38+
4. Review detected duplicates for each playlist.
39+
5. Remove all duplicates in one playlist by clicking the removal button. The first instance of each song will stay in your playlist.
40+
3541

36-
Scan results
42+
###Scan results
3743
![image](https://github.com/user-attachments/assets/291641a6-49f3-40b7-924e-f59b6ae5c518)
3844

39-
After deduping
45+
###After deduping
4046
![image](https://github.com/user-attachments/assets/4e4a6f82-cb39-449f-a39b-6f2f7519e03d)
4147

4248

49+
If you have further questions, check the ["Frequently asked questions"-section on the website](https://spotify-dedup.com/).
50+
4351
## Installation
4452

45-
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.
53+
### Using pnpm (recommended)
4654

47-
Also, ensure you have **pnpm** installed. If you don't have it, install it using the following gcommand:
55+
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.
56+
57+
To install the project, ensure you have **pnpm** installed. If you don't have it, install it using the following command:
4858

4959
npm install -g pnpm
5060

@@ -60,6 +70,10 @@ Run it locally:
6070

6171
Then, open your browser and navigate to http://localhost:3000.
6272

73+
### Using npm or yarn:
74+
75+
Instructions for npm or yarn can be found on their respective websites. The basic steps are similar to using pnpm.
76+
6377
## Testing
6478

6579
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.

0 commit comments

Comments
 (0)