From e7a7a36ff1e01da50319efb7f979c819f032c09b Mon Sep 17 00:00:00 2001 From: Chad Bailey Date: Wed, 27 Mar 2024 20:16:04 +0000 Subject: [PATCH] fixup --- examples/server/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/server/README.md b/examples/server/README.md index 11f75000f..fca4845ec 100644 --- a/examples/server/README.md +++ b/examples/server/README.md @@ -30,4 +30,4 @@ The server supports several options, which can be set in the body of a POST requ - `token_properties` (none): A JSON object (URL encoded if included as a GET parameter) for overriding default token properties. By default, the server creates an owner token with an expiration time of one hour. - `bot_properties` (none): A string containing any additional command-line args to pass to the bot. - `wait_for_bot` (true): Whether to wait for the bot to successfully join the room before returning a response from the server. If true, the server will start the bot script, then poll the room for up to 5 seconds to confirm the bot has joined the room. If it doesn't, the server will stop the bot and return a 500 response. If set to `false`, the server will start the bot, but immediately return a 200 response. This can be useful if the server is creating rooms for you, and you need the room URL to join the user to the room. -- `redirect` (true): If set to "true", instead of returning a 200 for GET requests, the server will return a 301 redirect to the ROOM_URL. This is handy for testing by creating a bot with a GET request directly in the browser. POST requests will never return redirects. +- `redirect` (true): Instead of returning a 200 for GET requests, the server will return a 301 redirect to the ROOM_URL. This is handy for testing by creating a bot with a GET request directly in the browser. POST requests will never return redirects. Set to `false` to get 200 responses with info in a JSON object even for GET requests.