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

Update README.md

Browse source
This commit is contained in:
Percs 2024-07-11 12:43:31 -05:00 • committed by GitHub
parent c9c0ef84ee
commit 816ddb8aea
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,4 +1,5 @@
# 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.
@ -34,6 +35,21 @@ export interface BareTransport {
meta: () => BareMeta
}
```
## Upgrading
A guide for updating from v1 to v2 can be found [here](https://github.com/MercuryWorkshop/bare-mux/blob/master/documentation/Upgrading.md).
## Older bare-mux versions
Starting from v2, bare-mux uses [SharedWorkers](https://developer.mozilla.org/en-US/docs/Web/API/SharedWorker) to provide stability and improve on resource usage.
If you operate using an older bare-mux, we encourage you to update.
If you're too lazy to do either of the above, you can install an outdated and unsupported version of bare-mux.
```sh
npm install @mercuryworkshop/bare-mux@1
```
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).