From 661aefb507708e091a89c6e5386f89e56af982aa Mon Sep 17 00:00:00 2001 From: Owen Schwartz Date: Fri, 3 Jan 2025 21:53:16 -0500 Subject: [PATCH] Add bullets --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 099ee5e..5354285 100644 --- a/README.md +++ b/README.md @@ -31,17 +31,17 @@ Bytes transmitted in and out of each peer is collected every 10 seconds and incr ## CLI Args -`reachableAt`: How should the remote server reach Gerbil's API? -`generateAndSaveKeyTo`: Where to save the generated Wireguard private key to persist across restarts. -`remoteConfig` (optional): Remote config location to HTTP get the JSON based config from. See `example_config.json` -`config` (optional): Local JSON file path to load config. Used if remote config is not supplied. See `example_config.json` +- `reachableAt`: How should the remote server reach Gerbil's API? +- `generateAndSaveKeyTo`: Where to save the generated Wireguard private key to persist across restarts. +- `remoteConfig` (optional): Remote config location to HTTP get the JSON based config from. See `example_config.json` +- `config` (optional): Local JSON file path to load config. Used if remote config is not supplied. See `example_config.json` Note: You must use either `config` or `remoteConfig` to configure Wireguard. -`reportBandwidthTo` (optional): Remote HTTP endpoint to send peer bandwidth data -`interface` (optional): Name of the Wireguard interface created by Gerbil. Default: `wg0` -`listen` (optional): Port to listen on for HTTP server. Default: `3003` -`log-level` (optional): The log level to use. Default: INFO +- `reportBandwidthTo` (optional): Remote HTTP endpoint to send peer bandwidth data +- `interface` (optional): Name of the Wireguard interface created by Gerbil. Default: `wg0` +- `listen` (optional): Port to listen on for HTTP server. Default: `3003` +- `log-level` (optional): The log level to use. Default: INFO Example: