Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yogeshwaran01 committed Jul 13, 2022
1 parent 13d0c18 commit 9e0a73d
Showing 1 changed file with 39 additions and 6 deletions.
45 changes: 39 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ pip install lyricy
- Easy to add lyrics to your offline songs
- Preview of lyrics
- Synced lyrics with lru time tags
- Lyrics lru without tags
- Lyrics without lru tags
- Save lyrics as lru file
- Add your own lyrics or downloaed lyrics to songs

## Usage

Expand All @@ -42,19 +44,28 @@ Commands:
show Show the lyrics of TRACK if available.
```

- [Searching for lyrics using your queries](#searching-for-lyrics-using-your-queries)
- [Searching for lyrics for your track](#searching-for-lyrics-for-your-track)
- [Adding lyrics](#adding-lyrics)
- [Remove lyrics](#remove-lyrics)
- [Show lyrics](#show-lyrics)
- [Downloading lrc file](#downloading-lrc-file)
- [Add lrc file to song](#add-lrc-file-to-song)

### Searching for lyrics using your queries

```txt
Usage: [OPTIONS]
Usage: python -m lyricy search [OPTIONS]
Search for lyrics for given track or query
Options:
-t, --track PATH file path of track
-d, --disable-preview Disable the preview
-l, --only-lyrics Show Lyrics Only (without LRC tag)
-s, --save TEXT Save file as .lrc
-q, --query TEXT search query of track name
--help Show this message and exit.
--help Show this message and exit
```

```bash
Expand All @@ -76,26 +87,32 @@ After searching it print list of lyrics, enter the index number lyrics to get th
Adding lyrics to track metadata to get synced lyrics

```txt
Usage: lyricy add [OPTIONS] TRACK
Usage: python -m lyricy add [OPTIONS] TRACK
Search and add lyrics to given TRACK.
TRACK is the filepath of track.
Options:
-q, --query TEXT search for this query instead of track name
-d, --disable-preview Disable the preview
--show Print the lyrics and ask for confirmation
--lru PATH Lyrics file to add on track
--help Show this message and exit.
```

Track must have ablum metameta `title`

```bash
lyricy add 'Imagine Dragons - Believer.mp3'
```

select the prefferd lyrics for the song to add it

If track does not have metadata `title` or any other unrevelant name, use can use `--query` option to override this.

```bash
lyricy add 'some-track.mp3' --query "vikram title track"
```

### Remove lyrics

```txt
Expand Down Expand Up @@ -131,6 +148,22 @@ Options:
lyricy show 'Imagine Dragons - Believer.mp31
```
### Downloading lrc file
```bash
lyricy search --query "new york" --save "new_york"
```
This search and ask for the prompt, select any song it will download and save as `lrc` file
### Add lrc file to song
```bash
lyricy add track.mp3 --lru track.lru
```
It will add the lyrics to song metadata
## Source of lyrics
All lyrics are scraped from [https://www.megalobiz.com/](https://www.megalobiz.com/)
Expand Down

0 comments on commit 9e0a73d

Please sign in to comment.