Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
skuill authored Dec 9, 2023
1 parent d517c52 commit 3da8b75
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ LyricsScraperNET is a library for .NET that provides an API to search for lyrics
- [Genius](https://genius.com/)
- [MusixMatch](https://www.musixmatch.com/)
- [SongLyrics](https://www.songlyrics.com/)
- [LyricFind](https://www.lyricfind.com/) (**TODO**)
- [LyricFind](https://www.lyricfind.com/)
- [Lyrics](https://www.lyrics.com/) (**TODO**)

## Example

A simple way to initialize through a parameterless constructor with the addition of the necessary lyric providers:

```csharp
using LyricsScraperNET;
using LyricsScraperNET.Models.Requests;
Expand All @@ -36,10 +38,11 @@ class Program
// Create instance of LyricScraperClient with different lyrics providers
ILyricsScraperClient lyricsScraperClient
= new LyricsScraperClient()
.WithAZLyrics()
.WithGenius()
.WithAZLyrics()
.WithMusixmatch()
.WithSongLyrics();
.WithSongLyrics()
.WithLyricFind();

var searchRequest = new ArtistAndSongSearchRequest(artist: "Metallica", song: "Nothing Else Matters");

Expand All @@ -50,11 +53,14 @@ class Program
}
}
```
There are also extension methods for setting up LyricScraperClient as IServiceCollection that stored in some IConfiguration.

More examples can be found in example project: [LyricsScraperNET.Client](LyricsScraperNET.Client/Program.cs)

## Contributing and Feedback

Feel free to send me feedback on [Telegram](https://t.me/skuill).

You are more than welcome to contribute to this project. Fork and make a Pull Request, or [create an Issue](https://github.com/skuill/LyricScraperNET/issues/new) if you see any problem or want to propose a feature.

## Support
Expand Down

0 comments on commit 3da8b75

Please sign in to comment.