From d6e0517ddb0cb0607c1deccc92a84a76ae1345c1 Mon Sep 17 00:00:00 2001 From: Janis Meister Date: Fri, 30 Jun 2023 13:19:55 +0200 Subject: [PATCH] [refactor] update readme paramter table --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 646bed0..50217b9 100644 --- a/README.md +++ b/README.md @@ -43,14 +43,15 @@ Start by adding a `?` to the end of the URL and then add the parameters. To add multiple parameters, you have to seperate them with a `&`. Like this: `file://C:/Users/.../index.html?parameter1=value1¶meter2=value2` -Real example: `file://C:/Users/.../index.html?remoteAppPort=5899` +Real example: `file://C:/Users/.../index.html?remoteAppPort=5899&hideNonTalking=true&clientLimit=5` This is a list of all available parameters (all parameters are optional): -| Parameter | Description | Type | Default | -| ---------------- | -------------------------------------- | ------- | ------- | -| `remoteAppPort` | The port of the Teamspeak 5 remote app | number | `5899` | -| `hideNonTalking` | Hide all non-talking clients | boolean | `false` | +| Parameter | Description | Type | Default | +| ---------------- | ---------------------------------------- | ------- | --------------- | +| `remoteAppPort` | The port of the Teamspeak 5 remote app | number | `5899` | +| `hideNonTalking` | Hide all non-talking clients | boolean | `false` | +| `clientLimit` | Count of how many client should be shown | number | `0` (unlimited) | ## Setup (Developer)