From 3388f70498032eeab0d1f15c4a9cec64c844df6d Mon Sep 17 00:00:00 2001 From: Yuzu Date: Tue, 12 Jul 2022 02:29:37 -0500 Subject: [PATCH] chore: clarify where the library runs --- README.md | 18 +++++++++++++++--- build.ts | 3 --- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f6f528f..5ae765c 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ ## A brand new bleeding edge non bloated Discord library -### Install -```sh +### Install (node18) +```sh-session npm install @oasisjs/biscuit ``` -> or via [cdn](dummy link) +> or via [cdn](https://nest.land/package/oasis) The biscuit Discord library is built ontop of Discordeno and webspec APIs, we aim to provide portability. @@ -55,3 +55,15 @@ session.start(); * 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 + +### Compatibility + +#### bun +since bun is unestable I highly recommend running biscuit on node! +* We got the library running on EndeavourOS but it spams the ready event multiple times +* We got the library running on Arch/Artix Linux but breaks when sending fetch requests +* We got the library running on WSL + +#### node +* all DNT shims work properly +* a Node version is will to be available soon diff --git a/build.ts b/build.ts index fef1546..e940537 100644 --- a/build.ts +++ b/build.ts @@ -4,9 +4,6 @@ await Deno.remove('npm', { recursive: true }).catch((_) => {}); await build({ shims: { - undici: true, - deno: true, - timers: true, custom: [ { package: {