From 9c49e68daf72d5ec5269c1a1fac65628999c386a Mon Sep 17 00:00:00 2001 From: Toshit Chawda Date: Mon, 22 Jul 2024 14:24:30 -0700 Subject: [PATCH] add server readme --- server/README.md | 9 +++++++++ server/src/config.rs | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 server/README.md diff --git a/server/README.md b/server/README.md new file mode 100644 index 0000000..28d2f78 --- /dev/null +++ b/server/README.md @@ -0,0 +1,9 @@ +# `epoxy-server` +Performant server implementation of the Wisp protocol in Rust, made for epoxy. + +You can view a recent flamegraph of the server under load [here](flamegraph.svg?raw=true). + +## Configuration +`epoxy-server` is configured through a configuration file in either TOML, JSON, or YAML. Pass the configuration file's path as an argument to `epoxy-server`. + +The defaults can be printed with the command line option `--default-config` and the configuration file format can be changed from the default of TOML with the command line option `--format`. Documentation for the available configuration options is in [`src/config.rs`](src/config.rs). diff --git a/server/src/config.rs b/server/src/config.rs index dd3708c..c5a809e 100644 --- a/server/src/config.rs +++ b/server/src/config.rs @@ -295,7 +295,7 @@ pub enum ConfigFormat { Yaml, } -/// Server implementation of the Wisp protocol in Rust, made for epoxy. +/// Performant server implementation of the Wisp protocol in Rust, made for epoxy. #[derive(Parser)] #[command(version = clap::crate_version!())] pub struct Cli {