Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
palinkiewicz committed Aug 5, 2024
1 parent f18b4b4 commit fc524dd
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# LyricPost

> A simple yet powerful Spotify-like lyrics image generator built entirely with vanilla JavaScript.
## Introduction

LyricPost is a web application that allows users to generate Spotify-like lyrics images.
By entering the name of a song, users can fetch songs from Spotify, select one, and then fetch the corresponding lyrics from lrclib.
Users can then select lines from the lyrics and generate a stylish image with customizable colors and other settings.

## Features

- Finding a song using [Spotify Web API](https://developer.spotify.com/documentation/web-api)
- Fetching the lyrics from [lrclib](https://lrclib.net/docs)
- Generating a share-ready lyrics image with selected lyrics
- Customizing colors and other elements of the generated image
- Downloading the image in high quality

## Live version

You can check it out [here](https://palinkiewicz.github.io/lyricpost/).

## Screenshots

Light mode | Dark mode
:-------------------------:|:-------------------------:

## Local installation

1. Clone the repo <br> ```git clone https://github.com/yourusername/lyricpost.git```
2. Run index.html

It's that easy!

## Disclaimer
This project is not affiliated with or endorsed by Spotify.
The Spotify logo is used in compliance with Spotify's branding guidelines and is fetched from an outside source.

0 comments on commit fc524dd

Please sign in to comment.