Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
viztea authored Aug 23, 2020
1 parent 91caa31 commit d6199ce
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,42 @@
<img align="center" src="./assets/banner.png" alt="lavadeno banner">
<h1 align="center">Lavadeno</h1>
<hr />
<blockquote>
A powerful lavalink client built on the <strong>Deno</strong> Runtime
<p><a href="https://discord.gg/vuJxnYk">Discord Server</a> &bull; <a href="https://github.com/lavaclient/lavadeno">Github</a></p>
</blockquote>

A powerful lavalink client built on the [Deno](https://deno.land/) Runtime
- **Flexible**: Lavadeno is not restricted to a specific discord library. Meaning you only need a connection to the discord gateway for it to work.
- **Easy-to-Use**: Lavadeno has a neat and user-friendly promise-based api.
- **Lightweight**: Designed to be small and performant, it's a great choice for any sized project.


<h2 align="center">Setup</h2>

- Deno 1.3.x
- Lavalink
- [Official](https://github.com/frederikam/lavalink)
- [With Filters (Unofficial)](https://github.com/melike2d/lavalink/)
- Connection to the Discord Gateway.

```ts
import { Manager } from "https://deno.land/x/lavadeno/mod.ts";

const nodes = [
{
id: "main",
host: "localhost",
port: 2333,
password: "youshallnotpass"
}
]

const manager = new Manager(nodes, {
send(id, payload) {
sendPayloadToDiscord();
}
});
```

---

<p align="center"><a href="https://melike2d.me">melike2d</a> &copy; 2020</p>

0 comments on commit d6199ce

Please sign in to comment.