readme improvements

This commit is contained in:
Toshit Chawda 2024-12-21 18:33:17 -08:00
parent 7ce772da7d
commit 194ad4e5c8
No known key found for this signature in database
GPG key ID: 91480ED99E2B3D9D
4 changed files with 68 additions and 44 deletions

View file

@ -1,13 +1,11 @@
# `epoxy-server`
Performant server implementation of the Wisp protocol in Rust, made for epoxy.
Performant server implementation of the Wisp protocol in Rust, made for epoxy-client.
You can view a recent flamegraph of the server under load [here](flamegraph.svg?raw=true).
## Building
> [!IMPORTANT]
> Rust nightly is required.
```
```bash
cargo b -r
```
The executable will be placed at `target/release/epoxy-server`.