Skip to content

Commit

Permalink
Added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
appujet committed Apr 28, 2024
1 parent 1b1894e commit 10c057d
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# jioSaavn Plugin For Lavalink

- This is a plugin for [Lavalink](https://github.com/lavalink-devs/Lavalink)
- This plugin allows you to play songs from JioSaavn in your discord server.
- This plugin uses the [JioSaavn API](https://github.com/sumitkolhe/jiosaavn-api) to fetch songs.


# API

> [!NOTE]
> You need `Bun(1.0.26+)` or `Node.js(v18+)`
1. Clone the repository:

```sh
git clone https://github.com/sumitkolhe/jiosaavn-api
cd jiosaavn-api
```

2. Install the required dependencies:

```sh
bun install
```

3. Launch the development server:

```sh
bun run dev
```

## ☁️ Deploying Your Own Instance

You can easily deploy your own instance of the API by clicking the button below:

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/sumitkolhe/jiosaavn-api)

> [!TIP]
> To ensure the API provides results in the intended language, configure the [Serverless Function Region](https://vercel.com/docs/concepts/functions/serverless-functions/regions) in Vercel to `Mumbai, India (South) - > bom1`.
## 🚀 Usage

0 comments on commit 10c057d

Please sign in to comment.