chore: clean up readme

This commit is contained in:
Percs 2024-10-12 18:01:11 -05:00
parent 613a52c92f
commit 647567b480

View file

@ -3,15 +3,52 @@
</div>
---
> [!WARNING]
> Scramjet is not currently production ready, DO NOT USE THIS AS THE MAIN OPTION IN YOUR SITE.
<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>
Scramjet is an experimental web proxy that aims to be the successor to Ultraviolet.
Scramjet is an experimental inteception based web proxy that aims to be the successor to Ultraviolet. It is designed with security, developer friendlyness, and performance in mind. Scramjet strives to have a clean, organized codebase to improve maintainability. Scramjet is made to evade internet censorship and arbitrary bypass web browser restrictions.
It is not currently production ready, DO NOT USE THIS AS THE MAIN OPTION IN YOUR SITE
## Supported Sites
Some of the popular websites that Scramjet supports include:
# Development
```
pnpm i
- [Google](https://google.com)
- [Youtube](https://www.youtube.com)
- [Spotify](https://spotify.com)
- [Discord](https://discord.com)
- [Reddit](https://reddit.com)
- [GeForce NOW](https://play.geforcenow.com/)
- [now.gg](https://now.gg)
## Development
### Dependencies
- Recent versions of `node.js` and `pnpm`
- `rustup`
- `wasm-bindgen`
- `wasm-opt`
#### Building
- Clone the repository with `git clone --recursive https://github.com/MercuryWorkshop/scramjet`
- Then, install your dependencies with `pnpm i`
- After, build the rewriter with `pnpm rewriter:build`
- Finally, build Scramjet with `pnpm build`
### Running Scramjet Locally
You can run the Scramjet dev server with the command
```sh
pnpm dev
```
Scramjet should now be running at `localhost:1337` and should rebuild upon a file being changed (excluding the rewriter).
## Documentation
See the current index of documentation [here](./documentation/README.md).