From 8717f964d3d639c181aef21f25318b4d42331da5 Mon Sep 17 00:00:00 2001 From: spiral Date: Fri, 11 Nov 2022 23:38:17 +0000 Subject: [PATCH] fix(docs): mark PluralKit.Bot.ClientId as a required configuration key --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f807698..84646fc3 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ The configuration file is in JSON format (albeit with a `.conf` extension). The * **`PluralKit.Bot.Token`**: the Discord bot token to connect with * **`PluralKit.Database`**: the URI of the database to connect to (in [ADO.NET Npgsql format](https://www.connectionstrings.com/npgsql/)) * `PluralKit.Bot.Prefixes`: an array of command prefixes to use (default `["pk;", "pk!"]`). -* `PluralKit.Bot.ClientId` *(optional)*: the ID of the bot's user account, used when generating invite links through `pk;invite`. It's automatically determined if not present, but overriding it may be useful for private instances that still want a public invite link. +* **`PluralKit.Bot.ClientId`**: the ID of the bot's user account, used for calculating the bot's own permissions and for the link in `pk;invite`. * `PluralKit.SentryUrl` *(optional)*: the [Sentry](https://sentry.io/welcome/) client key/DSN to report runtime errors to. If absent, disables Sentry integration. * `PluralKit.InfluxUrl` *(optional)*: the URL to an [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) server to report aggregate statistics to. An example of these stats can be seen on [the public stats page](https://stats.pluralkit.me). * `PluralKit.InfluxDb` *(optional)*: the name of an InfluxDB database to report statistics to. If either this field or `PluralKit.InfluxUrl` are absent, InfluxDB reporting will be disabled.