Skip to content

Commit 751590b

Browse files
committed
Improved README.md
- For easier readability, a table of content was added at the top of the readme. - A new Badge now displays the amount of open issues. This helps new people see the amount of chances to contribute. - Rewrote introduction to outline the project more clearly - To highlight the features of this project, a new feature section was created. - To visualize and give a quick tutorial on the project's workflow, a guide was added. - To help new people with the installation process, more detailled commands were added. This includes the installation of the required pnpm, as well as needed git commands - To standardize other user's contributions to this project, a new section was created in the readme. It includes needed commands as well as a tip concerning large changes - For better visibility, a link to the license was added at the bottom of the readme.
1 parent 4a4961d commit 751590b

1 file changed

Lines changed: 74 additions & 10 deletions

File tree

README.md

Lines changed: 74 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,78 @@
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/)
5+
[![GitHub issues](https://img.shields.io/github/issues/JMPerez/spotify-dedup)](https://github.com/JMPerez/spotify-dedup/issues)
46

5-
Have you ever wanted to remove duplicated songs from your Spotify library? Now you can find and remove them using Spotify Dedup.
7+
## Table of Contents
8+
## Table of Contents
9+
1. [Introduction](#introduction)
10+
2. [Features](#features)
11+
3. [Usage](#usage)
12+
4. [Installation](#installation)
13+
- [Using pnpm (recommended)](#using-pnpm-recommended)
14+
- [Using npm or yarn](#using-npm-or-yarn)
15+
5. [Testing](#testing)
16+
6. [About the Tools Used](#about-the-tools-used-and-implementation-details)
17+
- [Spotify Web API and Promises](#spotify-web-api-and-promises)
18+
7. [Contributing](#contributing)
19+
8. [License](#license)
620

7-
This project uses the [Spotify Web API](https://developer.spotify.com/web-api/) for managing playlists. Just log in and it will traverse your playlists, finding songs that appear multiple times with the same identifier (Spotify URI) in a given playlist.
821

9-
If it finds duplicates, they can be removed just pushing a button. And since it doesn't create a whole new playlist, it keeps all the information like creation date and subscribers.
22+
## Introduction
23+
Have you ever wanted to remove duplicated songs from your Spotify library? Now you can find and remove them using Spotify Dedup. Spotify Deduplicator is a simple and effective tool for cleaning up your Spotify library. Just log in and it will traverse your playlists, finding duplicate songs. It uses the [Spotify Web API](https://developer.spotify.com/web-api/) to identify songs that appear multiple times in a given playlist. With the press of a button, you can remove duplicate tracks from your playlists and liked songs. It saves time and effort by avoiding the need to manually check for duplicate entries, which can be especially useful for users with large music libraries. No playlists are re-created, ensuring all metadata like creation dates and followers are preserved.
1024

11-
## Try it
25+
## Features
26+
- **Automatic Duplicate Detection**: Finds duplicate tracks in playlists and liked songs.
27+
- **Detect all duplicate**: Finds duplicates that Spotify does not detect by comparing ID, title, artist, and duration similarity.
28+
- **Playlist Integrity**: Removes duplicates without creating new playlists, retaining original creation dates and follower counts.
29+
- **Save Time and Effort**: No more manually searching for duplicates. Spotify Deduplicator scans your entire library efficiently.
30+
- **Cross-Platform**: Works directly in your browser or can be run locally.
1231

13-
You can check it out on [https://spotify-dedup.com](https://spotify-dedup.com) or run it locally.
32+
## Usage
1433

15-
## Install and run
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.
1640

17-
Install the dependencies:
1841

19-
pnpm install
42+
###Scan results
43+
![image](https://github.com/user-attachments/assets/291641a6-49f3-40b7-924e-f59b6ae5c518)
44+
45+
###After deduping
46+
![image](https://github.com/user-attachments/assets/4e4a6f82-cb39-449f-a39b-6f2f7519e03d)
47+
48+
49+
If you have further questions, check the ["Frequently asked questions"-section on the website](https://spotify-dedup.com/).
50+
51+
## Installation
52+
53+
### Using pnpm (recommended)
54+
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:
2058

21-
Run it:
59+
npm install -g pnpm
60+
61+
Now, clone the repository and install dependencies::
62+
63+
git clone https://github.com/JMPerez/spotify-dedup.git
64+
cd spotify-dedup
65+
pnpm install
66+
67+
Run it locally:
2268

2369
pnpm dev
2470

25-
Then open http://localhost:3000 in a browser
71+
Then, open your browser and navigate to http://localhost:3000.
72+
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.
2676

2777
## Testing
2878

@@ -33,3 +83,17 @@ In order to test saved tracks, create duplicated tracks by executing the Web API
3383
### Spotify Web API and Promises
3484

3585
This app is a good example of how to traverse a user's library without incurring in rate limit. Have a look at the code and see how Promises and a Promise Queue are used to control the amount of requests sent to the Spotify Web API. If you are interested in throttling promises, check out [promise-throttle](https://github.com/JMPerez/promise-throttle).
86+
87+
## Contributing
88+
Contributions are welcome! Feel free to open issues or submit pull requests.
89+
90+
1. Fork the repository.
91+
2. Create a new branch (`git checkout -b feature-branch`).
92+
3. Make your changes.
93+
4. Commit and push your changes (`git commit -m "Add feature"`).
94+
5. Open a pull request.
95+
96+
For larger changes, it is recommended to open an issue first to discuss your ideas.
97+
98+
## License
99+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) for details.

0 commit comments

Comments
 (0)