diff --git a/README.md b/README.md index fb9e409..f6f528f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,29 @@ # biscuit ## A brand new bleeding edge non bloated Discord library -The biscuit Discord library is built ontop of Discordeno and webspec APIs, we aim to provide portability and scalabilty. -Most importantly, biscuit is: +### Install +```sh +npm install @oasisjs/biscuit +``` +> or via [cdn](dummy link) + +The biscuit Discord library is built ontop of Discordeno and webspec APIs, we aim to provide portability. + +### Most importantly, biscuit is: * A modular [Discordeno](https://github.com/discordeno/discordeno) fork -* A portable cross platform Discord library -* A framework to build Discord bots in Deno +* A framework to build Discord bots * A bleeding edge API to contact Discord -Biscuit is primarly inspired by Discord.js and Discordeno but it does not include a cache layer by default +Biscuit is primarly inspired by Discord.js and Discordeno but it does not include a cache layer by default, we believe that you should not make software that does things it is not supposed to do. -# Example bot +### Why biscuit?: +* [Minimal](https://en.wikipedia.org/wiki/Unix_philosophy), non feature-rich! +* Crossplatform +* Consistent +* Performant + +### Example bot (TS/JS) ```js import { GatewayIntents, Session } from "biscuit"; @@ -20,8 +32,8 @@ const token = "your token goes here"; const intents = GatewayIntents.MessageContent | GatewayIntents.Guilds | GatewayIntents.GuildMessages; const session = new Session({ token, intents }); -session.on("ready", (payload) => { - console.log("Logged in as:", payload.user.username) +session.on("ready", ({ user }) => { + console.log("Logged in as:", user.username); }); session.on("messageCreate", (message) => { @@ -32,3 +44,14 @@ session.on("messageCreate", (message) => { session.start(); ``` + +### Mininal style guide +* 4 spaces, no tabs +* Semi-colons are mandatory +* Run `deno fmt` +* Avoid circular dependencies + +### Contrib guide +* Install Deno extension [here](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno) +* Run `deno check` to make sure the library works +* Avoid sharing state between classes