mirror of
https://github.com/tiramisulabs/seyfert.git
synced 2025-07-03 05:26:07 +00:00
Update README's
This commit is contained in:
parent
6eb33cd8bf
commit
9ed913a821
@ -1,4 +1,6 @@
|
|||||||
# @biscuitland/api-types
|
# @biscuitland/api-types
|
||||||
|
## Most importantly, api-types is:
|
||||||
|
1:1 type definitions package for the [Discord](https://discord.com/developers/docs/intro) API.
|
||||||
|
|
||||||
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
||||||
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
||||||
@ -12,10 +14,6 @@ npm install @biscuitland/api-types
|
|||||||
yarn add @biscuitland/api-types
|
yarn add @biscuitland/api-types
|
||||||
```
|
```
|
||||||
|
|
||||||
## Most importantly, api-types is:
|
|
||||||
|
|
||||||
1:1 type definitions package for the [Discord](https://discord.com/developers/docs/intro) API:
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
|
4
packages/cache/README.md
vendored
4
packages/cache/README.md
vendored
@ -1,9 +1,9 @@
|
|||||||
# @biscuitland/cache
|
# @biscuitland/cache
|
||||||
|
Structures to create a custom cache completely decoupled from the rest of the library. You can choose to use a `MemoryCacheAdapter` or a `RedisCacheAdapter` according to your needs.
|
||||||
|
|
||||||
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
||||||
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
||||||
|
|
||||||
Structures to create a custom cache completely decoupled from the rest of the library. You can choose to use a `MemoryCacheAdapter` or a `RedisCacheAdapter` according to your needs.
|
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
* [Website](https://biscuitjs.com/)
|
* [Website](https://biscuitjs.com/)
|
||||||
* [Documentation](https://docs.biscuitjs.com/)
|
* [Documentation](https://docs.biscuitjs.com/)
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
# @biscuitland/core
|
# @biscuitland/core
|
||||||
|
Classes, functions and main structures to create an application with biscuit. Core contains the essentials to launch you to develop your own customized and scalable bot.
|
||||||
|
|
||||||
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
||||||
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
||||||
|
|
||||||
Classes, functions and main structures to create an application with biscuit. Core contains the essentials to launch you to develop your own customized and scalable bot.
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
### Install (for [node18](https://nodejs.org/en/download/))
|
### Install (for [node18](https://nodejs.org/en/download/))
|
||||||
|
@ -1,4 +1,7 @@
|
|||||||
# @biscuitland/helpers
|
# @biscuitland/helpers
|
||||||
|
## Most importantly, helpers is:
|
||||||
|
Collectors, builders and other helper functions such as setPresence.
|
||||||
|
|
||||||
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
||||||
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
||||||
|
|
||||||
@ -11,11 +14,6 @@ npm install @biscuitland/helpers
|
|||||||
yarn add @biscuitland/helpers
|
yarn add @biscuitland/helpers
|
||||||
```
|
```
|
||||||
|
|
||||||
## Most importantly, helpers is:
|
|
||||||
- Collectors
|
|
||||||
- Builders
|
|
||||||
- Other helper functions such as setPresence
|
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
* [Website](https://biscuitjs.com/)
|
* [Website](https://biscuitjs.com/)
|
||||||
* [Documentation](https://docs.biscuitjs.com/)
|
* [Documentation](https://docs.biscuitjs.com/)
|
||||||
|
@ -1,4 +1,7 @@
|
|||||||
# @biscuitland/rest
|
# @biscuitland/rest
|
||||||
|
## Most importantly, biscuit's rest is:
|
||||||
|
A standalone rest library that is yet easy to use and easy to host on a serverless infrastructure, it is meant to be used with biscuit's libraries.
|
||||||
|
|
||||||
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
||||||
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
||||||
|
|
||||||
@ -11,9 +14,6 @@ npm install @biscuitland/rest
|
|||||||
yarn add @biscuitland/rest
|
yarn add @biscuitland/rest
|
||||||
```
|
```
|
||||||
|
|
||||||
## Most importantly, biscuit's rest is:
|
|
||||||
A standalone rest library that is yet easy to use and easy to host on a serverless infrastructure, it is meant to be used with biscuit's libraries.
|
|
||||||
|
|
||||||
## Example (Standalone rest)
|
## Example (Standalone rest)
|
||||||
```ts
|
```ts
|
||||||
import { DefaultRestAdapter } from "@biscuitland/rest";
|
import { DefaultRestAdapter } from "@biscuitland/rest";
|
||||||
|
@ -1,4 +1,7 @@
|
|||||||
# @biscuitland/ws
|
# @biscuitland/ws
|
||||||
|
## Most importantly, biscuit's ws is:
|
||||||
|
A standalone gateway to interface Discord, it is meant to be used with a rest manager to send fetch requests to Discord
|
||||||
|
|
||||||
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
|
||||||
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
[<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
|
||||||
|
|
||||||
@ -11,9 +14,6 @@ npm install @biscuitland/ws
|
|||||||
yarn add @biscuitland/ws
|
yarn add @biscuitland/ws
|
||||||
```
|
```
|
||||||
|
|
||||||
## Most importantly, biscuit's ws is:
|
|
||||||
A standalone gateway to interface Discord, it is meant to be used with a rest manager to send fetch requests to Discord
|
|
||||||
|
|
||||||
## Example (GW proxy)
|
## Example (GW proxy)
|
||||||
```ts
|
```ts
|
||||||
import { DefaultWsAdapter } from "@biscuitland/ws";
|
import { DefaultWsAdapter } from "@biscuitland/ws";
|
||||||
|
Loading…
x
Reference in New Issue
Block a user