From 9ed913a821b0a410d2fa491bd29817eabdf38954 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Serna?= Date: Fri, 5 Aug 2022 11:17:33 -0300 Subject: [PATCH] Update README's --- packages/api-types/README.md | 6 ++---- packages/cache/README.md | 4 ++-- packages/core/README.md | 4 ++-- packages/helpers/README.md | 8 +++----- packages/rest/README.md | 6 +++--- packages/ws/README.md | 6 +++--- 6 files changed, 15 insertions(+), 19 deletions(-) diff --git a/packages/api-types/README.md b/packages/api-types/README.md index 8ecc9d5..122390a 100644 --- a/packages/api-types/README.md +++ b/packages/api-types/README.md @@ -1,4 +1,6 @@ # @biscuitland/api-types +## Most importantly, api-types is: +1:1 type definitions package for the [Discord](https://discord.com/developers/docs/intro) API. [](https://github.com/oasisjs/biscuit) [](https://discord.gg/XNw2RZFzaP) @@ -12,10 +14,6 @@ npm install @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 ```ts diff --git a/packages/cache/README.md b/packages/cache/README.md index 88f30a9..baeb998 100644 --- a/packages/cache/README.md +++ b/packages/cache/README.md @@ -1,9 +1,9 @@ # @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. + [](https://github.com/oasisjs/biscuit) [](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 * [Website](https://biscuitjs.com/) * [Documentation](https://docs.biscuitjs.com/) diff --git a/packages/core/README.md b/packages/core/README.md index e7460f7..47a4b23 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,9 +1,9 @@ # @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. + [](https://github.com/oasisjs/biscuit) [](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 ### Install (for [node18](https://nodejs.org/en/download/)) diff --git a/packages/helpers/README.md b/packages/helpers/README.md index da873d0..5aa1634 100644 --- a/packages/helpers/README.md +++ b/packages/helpers/README.md @@ -1,4 +1,7 @@ # @biscuitland/helpers +## Most importantly, helpers is: +Collectors, builders and other helper functions such as setPresence. + [](https://github.com/oasisjs/biscuit) [](https://discord.gg/XNw2RZFzaP) @@ -11,11 +14,6 @@ npm install @biscuitland/helpers yarn add @biscuitland/helpers ``` -## Most importantly, helpers is: -- Collectors -- Builders -- Other helper functions such as setPresence - ## Links * [Website](https://biscuitjs.com/) * [Documentation](https://docs.biscuitjs.com/) diff --git a/packages/rest/README.md b/packages/rest/README.md index 8655acb..ec23717 100644 --- a/packages/rest/README.md +++ b/packages/rest/README.md @@ -1,4 +1,7 @@ # @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. + [](https://github.com/oasisjs/biscuit) [](https://discord.gg/XNw2RZFzaP) @@ -11,9 +14,6 @@ npm install @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) ```ts import { DefaultRestAdapter } from "@biscuitland/rest"; diff --git a/packages/ws/README.md b/packages/ws/README.md index c1dd100..0ced763 100644 --- a/packages/ws/README.md +++ b/packages/ws/README.md @@ -1,4 +1,7 @@ # @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 + [](https://github.com/oasisjs/biscuit) [](https://discord.gg/XNw2RZFzaP) @@ -11,9 +14,6 @@ npm install @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) ```ts import { DefaultWsAdapter } from "@biscuitland/ws";