diff options
Diffstat (limited to 'node_modules/genius-lyrics/README.md')
-rw-r--r-- | node_modules/genius-lyrics/README.md | 142 |
1 files changed, 71 insertions, 71 deletions
diff --git a/node_modules/genius-lyrics/README.md b/node_modules/genius-lyrics/README.md index 949eee0..664a4e9 100644 --- a/node_modules/genius-lyrics/README.md +++ b/node_modules/genius-lyrics/README.md @@ -1,71 +1,71 @@ -<h1 align="center">Genius Lyrics 🎵</h1> - -[![npm](https://img.shields.io/npm/v/genius-lyrics)](https://npmjs.com/package/genius-lyrics) -[![npm](https://img.shields.io/npm/dw/genius-lyrics)](https://npmjs.com/package/genius-lyrics) -[![npm](https://img.shields.io/npm/l/genius-lyrics)](https://npmjs.com/package/genius-lyrics) -[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzyrouge%2Fgenius-lyrics.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzyrouge%2Fgenius-lyrics?ref=badge_shield) -[![Documentation](https://github.com/zyrouge/genius-lyrics/actions/workflows/docs.yml/badge.svg?branch=master)](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> +<h1 align="center">Genius Lyrics 🎵</h1>
+
+[![npm](https://img.shields.io/npm/v/genius-lyrics)](https://npmjs.com/package/genius-lyrics)
+[![npm](https://img.shields.io/npm/dw/genius-lyrics)](https://npmjs.com/package/genius-lyrics)
+[![npm](https://img.shields.io/npm/l/genius-lyrics)](https://npmjs.com/package/genius-lyrics)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzyrouge%2Fgenius-lyrics.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzyrouge%2Fgenius-lyrics?ref=badge_shield)
+[![Documentation](https://github.com/zyrouge/genius-lyrics/actions/workflows/docs.yml/badge.svg?branch=master)](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>
|