diff --git a/README.md b/README.md index e69de29..6e11862 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,53 @@ +# biscuit + +## A brand new bleeding edge non bloated Discord library + +biscuit + +### Install (for [node18](https://nodejs.org/en/download/)) + +```sh-session +npm install @biscuitland/core +yarn add @biscuitland/core +``` + +for further reading join our [Discord](https://discord.gg/zmuvzzEFz2) + +### Most importantly, biscuit is: + +- A wrapper to interface the Discord api +- A bleeding edge API to contact Discord + +Biscuit is primarily 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. + +### Why biscuit?: + +- [Minimal](https://en.wikipedia.org/wiki/Unix_philosophy), non feature-rich! +- Scalable + +### Example bot (TS/JS) + +```js +import { Session, GatewayIntents } from '@biscuitland/core'; + +const intents = GatewayIntents.MessageContent | GatewayIntents.Guilds | GatewayIntents.GuildMessages; +const session = new Session({ token: 'your token', intents }); + +session.events.on('ready', ({ user }) => { + console.log('Logged in as:', user.username); +}); + +session.events.on('messageCreate', (message) => { + if (message.content.startsWith('!ping')) { + message.reply({ content: 'pong!' }); + } +}); + +session.start(); +``` + +### Known issues: +- node18 is required to run the library, however --experimental-fetch flag should work on node16+ +- redis cache (wip) +- no optimal way to deliver a webspec bun version to the registry (#50) diff --git a/assets/icon.png b/assets/icon.png new file mode 100644 index 0000000..f122d29 Binary files /dev/null and b/assets/icon.png differ diff --git a/assets/icon.svg b/assets/icon.svg new file mode 100644 index 0000000..ab9169a --- /dev/null +++ b/assets/icon.svg @@ -0,0 +1,75 @@ + + + + + + + + + + + + + + + + +