From dc6dd6c08bd8b0162b5f65332cf0f96b5a357afa Mon Sep 17 00:00:00 2001 From: Yuzu Date: Mon, 1 Aug 2022 20:13:45 -0500 Subject: [PATCH] chore: api-types readme --- packages/api-types/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 packages/api-types/README.md diff --git a/packages/api-types/README.md b/packages/api-types/README.md new file mode 100644 index 0000000..67a4b7c --- /dev/null +++ b/packages/api-types/README.md @@ -0,0 +1,29 @@ + +# biscuit + +## A brand new bleeding edge non bloated Discord library + +biscuit + +## Install (for [node18](https://nodejs.org/en/download/)) + +```sh-session +npm install @biscuitland/api-types +yarn add @biscuitland/api-types +``` + +for further reading join our [Discord](https://discord.gg/zmuvzzEFz2) + +## Most importantly, api-types is: +1:1 type definitions package for the [Discord](https://discord.com/developers/docs/intro) API + +## Example +```ts +import type { DiscordUser } from '@biscuitland/api-types'; +``` +## Example for [Deno](https://deno.land/) +``` +import type { DiscordUser } from "https://unpkg.com/@biscuitland/api-types@1.1.0/dist/index.d.ts"; +``` + +We deliver this package through [unpkg](https://unpkg.com/) and it does contain constants and routes too