Fix links and update README's

This commit is contained in:
Nicolás Serna 2022-08-01 23:32:54 -03:00
parent a765fddf32
commit c6cb1fa103
6 changed files with 26 additions and 36 deletions

View File

@ -1,7 +1,6 @@
# @biscuitland/api-types
# 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)
## 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"/> <img align="right" src="https://raw.githubusercontent.com/oasisjs/biscuit/main/assets/icon.svg" alt="biscuit"/>
@ -12,8 +11,6 @@ npm install @biscuitland/api-types
yarn add @biscuitland/api-types yarn add @biscuitland/api-types
``` ```
for further reading join our [Discord](https://discord.gg/zqtPgyaFpV)
## Most importantly, api-types is: ## Most importantly, api-types is:
1:1 type definitions package for the [Discord](https://discord.com/developers/docs/intro) API: 1:1 type definitions package for the [Discord](https://discord.com/developers/docs/intro) API:
@ -31,5 +28,5 @@ We deliver this package through [unpkg](https://unpkg.com/) and it does contain
## Links ## Links
* [Website](https://biscuitjs.com/) * [Website](https://biscuitjs.com/)
* [Documentation](https://docs.biscuitjs.com/) * [Documentation](https://docs.biscuitjs.com/)
* [Discord](https://discord.gg/zqtPgyaFpV) * [Discord](https://discord.gg/XNw2RZFzaP)
* [api-types](https://www.npmjs.com/package/@biscuitland/api-types) * [core](https://www.npmjs.com/package/@biscuitland/core) | [cache](https://www.npmjs.com/package/@biscuitland/cache) | [rest](https://www.npmjs.com/package/@biscuitland/rest) | [ws](https://www.npmjs.com/package/@biscuitland/ws) | [helpers](https://www.npmjs.com/package/@biscuitland/helpers)

View File

@ -1,11 +1,11 @@
# @biscuitland/cache # @biscuitland/cache
[<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/KfNW3CpRfJ) [<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. 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/)
* [Discord](https://discord.gg/zqtPgyaFpV) * [Discord](https://discord.gg/XNw2RZFzaP)
* [cache](https://www.npmjs.com/package/@biscuitland/cache) * [core](https://www.npmjs.com/package/@biscuitland/core) | [api-types](https://www.npmjs.com/package/@biscuitland/api-types) | [rest](https://www.npmjs.com/package/@biscuitland/rest) | [ws](https://www.npmjs.com/package/@biscuitland/ws) | [helpers](https://www.npmjs.com/package/@biscuitland/helpers)

View File

@ -1,6 +1,6 @@
# @biscuitland/core # @biscuitland/core
[<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/KfNW3CpRfJ) [<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. 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.
@ -58,5 +58,5 @@ B:\project> node --experimental-fetch index.js
## Links ## Links
* [Website](https://biscuitjs.com/) * [Website](https://biscuitjs.com/)
* [Documentation](https://docs.biscuitjs.com/) * [Documentation](https://docs.biscuitjs.com/)
* [Discord](https://discord.gg/zqtPgyaFpV) * [Discord](https://discord.gg/XNw2RZFzaP)
* [core](https://www.npmjs.com/package/@biscuitland/core) * [api-types](https://www.npmjs.com/package/@biscuitland/api-types) | [cache](https://www.npmjs.com/package/@biscuitland/cache) | [rest](https://www.npmjs.com/package/@biscuitland/rest) | [ws](https://www.npmjs.com/package/@biscuitland/ws) | [helpers](https://www.npmjs.com/package/@biscuitland/helpers)

View File

@ -1,6 +1,6 @@
# biscuit # @biscuitland/helpers
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
## A brand new bleeding edge non bloated Discord library [<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
<img align="right" src="https://raw.githubusercontent.com/oasisjs/biscuit/main/assets/icon.svg" alt="biscuit"/> <img align="right" src="https://raw.githubusercontent.com/oasisjs/biscuit/main/assets/icon.svg" alt="biscuit"/>
@ -11,8 +11,6 @@ npm install @biscuitland/helpers
yarn add @biscuitland/helpers yarn add @biscuitland/helpers
``` ```
for further reading join our [Discord](https://discord.gg/zmuvzzEFz2)
## Most importantly, helpers is: ## Most importantly, helpers is:
- Collectors - Collectors
- Builders - Builders
@ -21,5 +19,5 @@ for further reading join our [Discord](https://discord.gg/zmuvzzEFz2)
## Links ## Links
* [Website](https://biscuitjs.com/) * [Website](https://biscuitjs.com/)
* [Documentation](https://docs.biscuitjs.com/) * [Documentation](https://docs.biscuitjs.com/)
* [Discord](https://discord.gg/zqtPgyaFpV) * [Discord](https://discord.gg/XNw2RZFzaP)
* [helpers](https://www.npmjs.com/package/@biscuitland/helpers) * [core](https://www.npmjs.com/package/@biscuitland/core) | [api-types](https://www.npmjs.com/package/@biscuitland/api-types) | [cache](https://www.npmjs.com/package/@biscuitland/cache) | [rest](https://www.npmjs.com/package/@biscuitland/rest) | [ws](https://www.npmjs.com/package/@biscuitland/ws)

View File

@ -1,6 +1,6 @@
# biscuit # @biscuitland/rest
[<img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white">](https://github.com/oasisjs/biscuit)
## A brand new bleeding edge non bloated Discord library [<img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/XNw2RZFzaP)
<img align="right" src="https://raw.githubusercontent.com/oasisjs/biscuit/main/assets/icon.svg" alt="biscuit"/> <img align="right" src="https://raw.githubusercontent.com/oasisjs/biscuit/main/assets/icon.svg" alt="biscuit"/>
@ -11,8 +11,6 @@ npm install @biscuitland/rest
yarn add @biscuitland/rest yarn add @biscuitland/rest
``` ```
for further reading join our [Discord](https://discord.gg/zqtPgyaFpV)
## Most importantly, biscuit's rest is: ## 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. 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.
@ -65,5 +63,5 @@ This package can be delivered through [unpkg](https://unpkg.com/) however is not
## Links ## Links
* [Website](https://biscuitjs.com/) * [Website](https://biscuitjs.com/)
* [Documentation](https://docs.biscuitjs.com/) * [Documentation](https://docs.biscuitjs.com/)
* [Discord](https://discord.gg/zqtPgyaFpV) * [Discord](https://discord.gg/XNw2RZFzaP)
* [rest](https://www.npmjs.com/package/@biscuitland/rest) * [core](https://www.npmjs.com/package/@biscuitland/core) | [api-types](https://www.npmjs.com/package/@biscuitland/api-types) | [cache](https://www.npmjs.com/package/@biscuitland/cache) | [ws](https://www.npmjs.com/package/@biscuitland/ws) | [helpers](https://www.npmjs.com/package/@biscuitland/helpers)

View File

@ -1,7 +1,6 @@
# @biscuitland/ws
# 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)
## 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"/> <img align="right" src="https://raw.githubusercontent.com/oasisjs/biscuit/main/assets/icon.svg" alt="biscuit"/>
@ -12,8 +11,6 @@ npm install @biscuitland/ws
yarn add @biscuitland/ws yarn add @biscuitland/ws
``` ```
for further reading join our [Discord](https://discord.gg/zqtPgyaFpV)
## Most importantly, biscuit's ws is: ## 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 A standalone gateway to interface Discord, it is meant to be used with a rest manager to send fetch requests to Discord
@ -71,5 +68,5 @@ wsManager.shards();
## Links ## Links
* [Website](https://biscuitjs.com/) * [Website](https://biscuitjs.com/)
* [Documentation](https://docs.biscuitjs.com/) * [Documentation](https://docs.biscuitjs.com/)
* [Discord](https://discord.gg/zqtPgyaFpV) * [Discord](https://discord.gg/XNw2RZFzaP)
* [ws](https://www.npmjs.com/package/@biscuitland/ws) * [core](https://www.npmjs.com/package/@biscuitland/core) | [api-types](https://www.npmjs.com/package/@biscuitland/api-types) | [cache](https://www.npmjs.com/package/@biscuitland/cache) | [rest](https://www.npmjs.com/package/@biscuitland/rest) | [helpers](https://www.npmjs.com/package/@biscuitland/helpers)