Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
moehmeni committed Jan 14, 2024
1 parent f8846ef commit 930e6e0
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,25 @@ pip install syncedlyrics
```
syncedlyrics "SEARCH_TERM"
```
You can also get a translation along the original lines (if available on Musixmatch):
```
syncedlyrics "SEARCH_TERM" -l es
```

#### Available Options
| Flag | Description |
| --- | --- |
| `-o` | Path to save `.lrc` lyrics, default="{search_term}.lrc" |
| `-p` | Comma-separated list of providers to include in searching |
| `-l` | Language of the translation along with the lyrics **(Curently only by Musixmatch)** |
| `-l` | Language code of the translation ([ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format) |
| `-v` | Use this flag to show the logs |
| `--allow-plain` | Return a plain text (not synced) lyrics if no LRC format was found |

### Python
```py
import syncedlyrics
lrc = syncedlyrics.search("[TRACK_NAME] [ARTIST_NAME]")
```
Or with options:
```py
syncedlyrics.search("...", allow_plain_format=True, save_path="{search_term}_1234.lrc", providers=["NetEase"])
```
Translated version (Note language codes should follow [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)):
Get a translation along with the original lyrics (seperated by `\n`):
```
syncedlyrics.search("...", lang="de")
```
Expand All @@ -45,7 +40,7 @@ syncedlyrics.search("...", lang="de")
- [Lrclib](https://github.com/tranxuanthang/lrcget/issues/2#issuecomment-1326925928)
- [NetEase](https://music.163.com/)
- [Megalobiz](https://www.megalobiz.com/)
- ~~[Lyricsify](https://www.lyricsify.com/)~~ (Broken, should bypass Cloudflare protection)
- ~~[Lyricsify](https://www.lyricsify.com/)~~ (Broken duo to Cloudflare protection)
- ~~[Deezer](https://deezer.com/)~~ (Broken)

Feel free to suggest more providers or make PRs to fix the broken ones.
Expand Down

0 comments on commit 930e6e0

Please sign in to comment.