soiz1 commited on
Commit
a182786
·
verified ·
1 Parent(s): bee6636

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +54 -51
README.md CHANGED
@@ -1,51 +1,54 @@
1
- <div align="center">
2
- <img src="assets/scramjet.png" height="200" />
3
- </div>
4
-
5
- ---
6
-
7
- > [!WARNING]
8
- > Scramjet is not currently production ready, DO NOT USE THIS AS THE MAIN OPTION IN YOUR SITE.
9
-
10
- <a href="https://www.npmjs.com/package/@mercuryworkshop/scramjet"><img src="https://img.shields.io/npm/v/@mercuryworkshop/scramjet.svg?maxAge=3600" alt="npm version" /></a>
11
-
12
- Scramjet is an experimental interception based web proxy that aims to be the successor to Ultraviolet. It is designed with security, developer friendliness, and performance in mind. Scramjet strives to have a clean, organized codebase to improve maintainability. Scramjet is made to evade internet censorship and bypass arbitrary web browser restrictions.
13
-
14
- ## Supported Sites
15
-
16
- Some of the popular websites that Scramjet supports include:
17
-
18
- - [Google](https://google.com)
19
- - [Youtube](https://www.youtube.com)
20
- - [Spotify](https://spotify.com)
21
- - [Discord](https://discord.com)
22
- - [Reddit](https://reddit.com)
23
- - [GeForce NOW](https://play.geforcenow.com/)
24
- - [now.gg](https://now.gg)
25
-
26
- ## Development
27
-
28
- ### Dependencies
29
-
30
- - Recent versions of `node.js` and `pnpm`
31
- - `rustup`
32
- - `wasm-bindgen`
33
- - [Binaryen's `wasm-opt`](https://github.com/WebAssembly/binaryen)
34
- - [this `wasm-snip` fork](https://github.com/r58Playz/wasm-snip)
35
-
36
- #### Building
37
-
38
- - Clone the repository with `git clone --recursive https://github.com/MercuryWorkshop/scramjet`
39
- - Install the dependencies with `pnpm i`
40
- - Build the rewriter with `pnpm rewriter:build`
41
- - Build Scramjet with `pnpm build`
42
-
43
- ### Running Scramjet Locally
44
-
45
- You can run the Scramjet dev server with the command
46
-
47
- ```sh
48
- pnpm dev
49
- ```
50
-
51
- Scramjet should now be running at `localhost:1337` and should rebuild upon a file being changed (excluding the rewriter).
 
 
 
 
1
+ ---
2
+ sdk: docker
3
+ ---
4
+ <div align="center">
5
+ <img src="assets/scramjet.png" height="200" />
6
+ </div>
7
+
8
+ ---
9
+
10
+ > [!WARNING]
11
+ > Scramjet is not currently production ready, DO NOT USE THIS AS THE MAIN OPTION IN YOUR SITE.
12
+
13
+ <a href="https://www.npmjs.com/package/@mercuryworkshop/scramjet"><img src="https://img.shields.io/npm/v/@mercuryworkshop/scramjet.svg?maxAge=3600" alt="npm version" /></a>
14
+
15
+ Scramjet is an experimental interception based web proxy that aims to be the successor to Ultraviolet. It is designed with security, developer friendliness, and performance in mind. Scramjet strives to have a clean, organized codebase to improve maintainability. Scramjet is made to evade internet censorship and bypass arbitrary web browser restrictions.
16
+
17
+ ## Supported Sites
18
+
19
+ Some of the popular websites that Scramjet supports include:
20
+
21
+ - [Google](https://google.com)
22
+ - [Youtube](https://www.youtube.com)
23
+ - [Spotify](https://spotify.com)
24
+ - [Discord](https://discord.com)
25
+ - [Reddit](https://reddit.com)
26
+ - [GeForce NOW](https://play.geforcenow.com/)
27
+ - [now.gg](https://now.gg)
28
+
29
+ ## Development
30
+
31
+ ### Dependencies
32
+
33
+ - Recent versions of `node.js` and `pnpm`
34
+ - `rustup`
35
+ - `wasm-bindgen`
36
+ - [Binaryen's `wasm-opt`](https://github.com/WebAssembly/binaryen)
37
+ - [this `wasm-snip` fork](https://github.com/r58Playz/wasm-snip)
38
+
39
+ #### Building
40
+
41
+ - Clone the repository with `git clone --recursive https://github.com/MercuryWorkshop/scramjet`
42
+ - Install the dependencies with `pnpm i`
43
+ - Build the rewriter with `pnpm rewriter:build`
44
+ - Build Scramjet with `pnpm build`
45
+
46
+ ### Running Scramjet Locally
47
+
48
+ You can run the Scramjet dev server with the command
49
+
50
+ ```sh
51
+ pnpm dev
52
+ ```
53
+
54
+ Scramjet should now be running at `localhost:1337` and should rebuild upon a file being changed (excluding the rewriter).