blob: 949eee0352b6447d428f1919156fcca1586e9c23 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
<h1 align="center">Genius Lyrics 🎵</h1>
[](https://npmjs.com/package/genius-lyrics)
[](https://npmjs.com/package/genius-lyrics)
[](https://npmjs.com/package/genius-lyrics)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fzyrouge%2Fgenius-lyrics?ref=badge_shield)
[](https://github.com/zyrouge/genius-lyrics/actions/workflows/docs.yml)
## 🤔 Whats is this?
Just a simple lyrics fetcher that uses [Genius](https://genius.com). This also has official API implementations.
## 💻 Installation
```
npm install genius-lyrics
```
## ⚙️ Usage
```js
const Genius = require("genius-lyrics");
const Client = new Genius.Client("top-secret-optional-key");
```
## 📎 Links
- [Documentation](https://genius-lyrics.js.org/)
- [NPM](https://npmjs.com/genius-lyrics)
- [GitHub](https://github.com/zyrouge/genius-lyrics)
## ✏️ Examples
### Requiring
**JavaScript**
```js
const Genius = require("genius-lyrics");
const Client = new Genius.Client("top-secret-optional-key"); // Scrapes if no key is provided
```
**TypeScript**
```ts
import Genius from "genius-lyrics";
const Client = new Genius.Client("top-secret-optional-key"); // Scrapes if no key is provided
```
### Fetching a Song and Lyrics
```js
const searches = await Client.songs.search("faded");
// Pick first one
const firstSong = searches[0];
console.log("About the Song:\n", firstSong, "\n");
// Ok lets get the lyrics
const lyrics = await firstSong.lyrics();
console.log("Lyrics of the Song:\n", lyrics, "\n");
```
### Fetching an Artist
```js
const artist = await Client.artists.get(456537);
console.log("About the Artist:\n", artist, "\n");
```
<br>
|
