mercuryworkshop-mirror/bare-mux
1
0
Fork 0
mirror of https://github.com/MercuryWorkshop/bare-mux.git synced 2025-05-16 15:40:01 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Percs 2024-07-07 17:48:31 -05:00
parent d9b3ffe51d
commit 228ddac643
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -42,13 +42,16 @@ Here is an example of using bare-mux:
/// As an end-user /// As an end-user
import { BareMuxConnection } from "@mercuryworkshop/bare-mux"; import { BareMuxConnection } from "@mercuryworkshop/bare-mux";
const conn = new BareMuxConnection("/bare-mux/worker.js"); const conn = new BareMuxConnection("/bare-mux/worker.js");
// Set Bare-Client transport // Set Bare-Client transport
// If your transport is an ES module and exports the class as the default export
await conn.setTransport("/bare-mux/transport-module.js", ["arg1", "ws://localhost:4000"]);
// Set Transport Manually
await conn.setManualTransport(` await conn.setManualTransport(`
const exports = await import("/bare-mux/transport.js"); const exports = await import("/bare-mux/transport.js");
return new exports.BareClient("https://tomp.app"); return new exports.BareClient("https://tomp.app");
`); `);
// If your transport is an ES module and exports the class as the default export
await conn.setTransport("/bare-mux/transport-module.js", ["arg1", "ws://localhost:4000"]);
/// As a proxy developer /// As a proxy developer
import { BareClient } from "@mercuryworkshop/bare-mux"; import { BareClient } from "@mercuryworkshop/bare-mux";