diff --git a/README.md b/README.md index 185947b..e71bd24 100755 --- a/README.md +++ b/README.md @@ -532,10 +532,11 @@ All configurations are initialized in the [`config/config.yaml`](config/config/y ### Running the Bulletin Board ```bash -go run cmd/bulletin-board/main.go -logLevel= +go run cmd/bulletin-board/main.go -logLevel= <-usePrev> ``` - Options: - ``: (optional) The logging level (e.g., "info", "debug", "warn", "error"). When the level is set as "Info", color printing is disabled. + - `<-usePrev>`: (optional) A boolean flag which enables the bulletin board to tell all the clients and relays to register again, using the addresses saved from the previous run (lastRegisteredClientsRelays.yml) ### Running a Relay @@ -557,8 +558,8 @@ go run cmd/client/main.go -id= -host= -port= -promPort=`: The unique identifier for the client. - ``: (optional) The public host IP for the client. If not given, the public IP will be retrieved automatically. - - ``: The port number for the client. When not specified, any available port is used. - - ``: The port number for scraping the client's Prometheus metrics. When not specified, any available port is used. + - ``: (optional) The port number for the client. When not specified, any available port is used. + - ``: (optional) The port number for scraping the client's Prometheus metrics. When not specified, any available port is used. - ``: (optional) The logging level (e.g., "info", "debug", "warn", "error"). When the level is set as "Info", color printing is disabled. ## Endpoints @@ -567,6 +568,9 @@ go run cmd/client/main.go -id= -host= -port= -promPort= -host= -port= -promPort=