mirror of
https://github.com/tiramisulabs/seyfert.git
synced 2025-07-04 22:16:08 +00:00
chore: api-types readme
This commit is contained in:
parent
bd7b8bca52
commit
dc6dd6c08b
29
packages/api-types/README.md
Normal file
29
packages/api-types/README.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
|
||||||
|
# biscuit
|
||||||
|
|
||||||
|
## A brand new bleeding edge non bloated Discord library
|
||||||
|
|
||||||
|
<img align="right" src="https://raw.githubusercontent.com/oasisjs/biscuit/main/assets/icon.svg" alt="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
|
Loading…
x
Reference in New Issue
Block a user