[repo]: https://github.com/vookav2/songlyrics
[issues]: https://github.com/vookav2/songlyrics/issues
[nodejs]: https://nodejs.org/
[codefactor]: https://www.codefactor.io/repository/github/vookav2/songlyrics
[npm]: https://www.npmjs.com/package/songlyrics
[versions]: https://www.npmjs.com/package/songlyrics?activeTab=versions
[buymeacoffee]: https://www.buymeacoffee.com/daphinokio
[saweria]: https://saweria.co/daphino
[mailto]: mailto:davinomoehdanino@gmail.com
# songlyrics
Search a lyrics. It scrapes the lyrics from unofficial sources.
[][buymeacoffee]
[][saweria]
[][codefactor]
[][versions]
[][npm]
Table of contents
-
Getting Started
-
Usage
-
Contributing
-
Disclaimer
-
Support
-
License
## Getting Started
### Prerequisites
- [Node.js][nodejs] v16 or greater
```
node --version
```
### Installation
- NPM
```sh
npm install songlyrics
```
- Yarn
```sh
yarn add songlyrics
```
## Usage
Import functions that you need.
```ts
import songlyrics from 'songlyrics'
const response = await songlyrics('one more light')
// with artist name
const response = await songlyrics('one more light linkin park')
```
### Output
Lyrics
```js
{
lyrics: string,
source: {
name: string,
url: string,
link: string,
},
}
```
## Contributing
Contributions, issues and feature requests are welcome. Feel free to check [issues][issues] page if you want to contribute.
## Support
Give a 🌟 [star][repo] if this project is useful to you.
## Disclaimer
This project is not affiliated with, endorsed, or sponsored by YouTube or any of their affiliates or subsidiaries. All trademarks, logos and brand names are the property of their respective owners, and are used only to directly describe the services being provided, as such, any usage of trademarks to refer to such services is considered nominative use.
Should you have any questions or concerns please contact me directly via [email][mailto].
## License
Distributed under the [MIT](https://github.com/vookav2/songlyrics/blob/main/LICENSE) License.
([⬆ back to top](#songlyrics))