From 5464da10ae838d4bb07b4ce4e0e1f390317109f5 Mon Sep 17 00:00:00 2001
From: Yuzu <yuzuru@programmer.net>
Date: Mon, 1 Aug 2022 20:36:53 -0500
Subject: [PATCH] chore: rest readme

---
 packages/api-types/README.md                  |  2 +-
 packages/core/README.md                       |  2 +-
 packages/helpers/README.md                    | 20 ++++++
 packages/{extra => helpers}/package.json      |  2 +-
 packages/{extra => helpers}/src/collectors.ts |  0
 packages/{extra => helpers}/src/index.ts      |  0
 packages/{extra => helpers}/tsconfig.json     |  0
 packages/{extra => helpers}/tsup.config.ts    |  0
 packages/rest/README.md                       | 63 +++++++++++++++++++
 9 files changed, 86 insertions(+), 3 deletions(-)
 create mode 100644 packages/helpers/README.md
 rename packages/{extra => helpers}/package.json (97%)
 rename packages/{extra => helpers}/src/collectors.ts (100%)
 rename packages/{extra => helpers}/src/index.ts (100%)
 rename packages/{extra => helpers}/tsconfig.json (100%)
 rename packages/{extra => helpers}/tsup.config.ts (100%)

diff --git a/packages/api-types/README.md b/packages/api-types/README.md
index 67a4b7c..35c1b5f 100644
--- a/packages/api-types/README.md
+++ b/packages/api-types/README.md
@@ -22,7 +22,7 @@ for further reading join our [Discord](https://discord.gg/zmuvzzEFz2)
 import type { DiscordUser } from '@biscuitland/api-types';
 ```
 ## Example for [Deno](https://deno.land/)
-```
+```ts
 import type { DiscordUser } from "https://unpkg.com/@biscuitland/api-types@1.1.0/dist/index.d.ts";
 ```
 
diff --git a/packages/core/README.md b/packages/core/README.md
index b5c22d8..648e72d 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -52,7 +52,7 @@ B:\project> node index.js
 
 For node 16.+:
 ```
-B:\project> node --experimenta-fetch index.js
+B:\project> node --experimental-fetch index.js
 ```
 
 ## Links
diff --git a/packages/helpers/README.md b/packages/helpers/README.md
new file mode 100644
index 0000000..b118169
--- /dev/null
+++ b/packages/helpers/README.md
@@ -0,0 +1,20 @@
+# 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/helpers
+yarn add @biscuitland/helpers
+```
+
+for further reading join our [Discord](https://discord.gg/zmuvzzEFz2)
+
+## Most importantly, helpers is:
+- Collectors
+- Builders
+- Other helper functions such as setPresence
+
diff --git a/packages/extra/package.json b/packages/helpers/package.json
similarity index 97%
rename from packages/extra/package.json
rename to packages/helpers/package.json
index 75476c9..b30cd05 100644
--- a/packages/extra/package.json
+++ b/packages/helpers/package.json
@@ -1,5 +1,5 @@
 {
-	"name": "@biscuitland/extra",
+	"name": "@biscuitland/helpers",
 	"version": "1.1.0",
 	"main": "./dist/index.js",
 	"module": "./dist/index.mjs",
diff --git a/packages/extra/src/collectors.ts b/packages/helpers/src/collectors.ts
similarity index 100%
rename from packages/extra/src/collectors.ts
rename to packages/helpers/src/collectors.ts
diff --git a/packages/extra/src/index.ts b/packages/helpers/src/index.ts
similarity index 100%
rename from packages/extra/src/index.ts
rename to packages/helpers/src/index.ts
diff --git a/packages/extra/tsconfig.json b/packages/helpers/tsconfig.json
similarity index 100%
rename from packages/extra/tsconfig.json
rename to packages/helpers/tsconfig.json
diff --git a/packages/extra/tsup.config.ts b/packages/helpers/tsup.config.ts
similarity index 100%
rename from packages/extra/tsup.config.ts
rename to packages/helpers/tsup.config.ts
diff --git a/packages/rest/README.md b/packages/rest/README.md
index e69de29..3b0dbdd 100644
--- a/packages/rest/README.md
+++ b/packages/rest/README.md
@@ -0,0 +1,63 @@
+# 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/rest
+yarn add @biscuitland/rest
+```
+
+for further reading join our [Discord](https://discord.gg/zmuvzzEFz2)
+
+## Most importantly, biscuit's rest is:
+An standalone rest library that is yet easy to use and easy to host on a serverless infraestructure, it is meant to be used with biscuit's libraries
+
+## Example
+```ts
+import { DefaultRestAdapter } from "@biscuitland/rest";
+import Fastify from "fastify";
+
+const manager = new DefaultRestAdapter({
+    url: `http://localhost:port...`,
+    token: "your token goes here",
+    version: 10,
+});
+
+const app = Fastify({});
+
+app.all("*", (req, reply) => {
+    let response: unknown;
+
+    switch (req.method) {
+    case "GET":
+        response = await rest.get(req.url, req.body);
+    break;
+    case "POST":
+        response = await rest.post(req.url, req.body);
+    break;
+    case "PUT":
+        response = await rest.put(req.url, req.body);
+    break;
+    case "PATCH":
+        response = await rest.patch(req.url, req.body);
+    break;
+    case "DELETE":
+        response = await rest.delete(req.url, req.body);
+    break;
+    }
+
+    if (response)
+        reply.status(200).send({ status: 200, data: response });
+
+    else
+        reply.status(204).send({ status: 204, data: null });
+});
+
+app.listen({ port: "port..." });
+```
+
+This package can be delivered through [unpkg](https://unpkg.com/) however is not tested yet