From 7a1273e9677778b1cd5181f38ce97d0a19580f00 Mon Sep 17 00:00:00 2001
From: Toshit Chawda <r58playz@gmail.com>
Date: Sun, 7 Jul 2024 14:16:45 -0700
Subject: [PATCH] create readme

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9f8ea42
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# Bare-Mux
+A system for managing http transports in a project such as [Ultraviolet](https://github.com/Titaniumnetwork-dev/Ultraviolet).
+
+Written to make the job of creating new standards for transporting http data seamless.
+
+Implements the [TompHTTP Bare](https://github.com/tomphttp/specifications/) client interface in a modular way.
+
+Specifically, this is what allows proxies such as [Nebula](https://github.com/NebulaServices/Nebula) to switch HTTP transports seamlessly.
+
+A transport is a module that implements the `BareTransport` interface.
+```js
+export interface BareTransport {
+  init: () => Promise<void>;
+  ready: boolean;
+  connect: (
+    url: URL,
+    origin: string,
+    protocols: string[],
+    requestHeaders: BareHeaders,
+    onopen: (protocol: string) => void,
+    onmessage: (data: Blob | ArrayBuffer | string) => void,
+    onclose: (code: number, reason: string) => void,
+    onerror: (error: string) => void,
+  ) => [( (data: Blob | ArrayBuffer | string) => void, (code: number, reason: string) => void )] => void;
+
+  request: (
+    remote: URL,
+    method: string,
+    body: BodyInit | null,
+    headers: BareHeaders,
+    signal: AbortSignal | undefined
+  ) => Promise<TransferrableResponse>;
+
+  meta: () => BareMeta
+}
+```
+
+Examples of transports include [EpoxyTransport](https://github.com/MercuryWorkshop/EpoxyTransport),  [CurlTransport](https://github.com/MercuryWorkshop/CurlTransport), and [Bare-Client](https://github.com/MercuryWorkshop/Bare-as-module3).
+
+Here is an example of using bare-mux:
+```js
+/// As an end-user
+import { BareMuxConnection } from "@mercuryworkshop/bare-mux";
+const conn = new BareMuxConnection("/bare-mux/worker.js");
+// Set Bare-Client transport
+await conn.setTransport(`return (async ()=>{
+    const exports = await import("/bare-mux/index.js");
+    return new exports.BareClient("https://tomp.app");
+})()`);
+
+/// As a proxy developer
+import { BareClient } from "@mercuryworkshop/bare-mux";
+const client = new BareClient();
+// Fetch
+const resp = await client.fetch("https://example.com");
+// Create websocket
+const ws = client.createWebSocket("wss://echo.websocket.events");
+```