From 822eb76a1c2cb052905d9918688454eb7a4febb7 Mon Sep 17 00:00:00 2001 From: Sergey A Date: Thu, 1 Jul 2021 10:46:14 +0300 Subject: [PATCH] Docs: add sample keyfile.toml --- docs/usage.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/usage.rst b/docs/usage.rst index f6e6e90..1125428 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -136,10 +136,19 @@ http_timeout Time in seconds to wait for HTTP requests. Default: 20. keyfile - Specify an ini config file containing key (token) information. This file + Specify a toml config file containing key (token) information. This file should contain a ``keys`` table, mapping key names to key values. See specific source for the key name(s) to use. + Sample ``keyfile.toml``: + + ```toml + [keys] + # https://github.com/settings/tokens + # scope: repo -> public_repo + github = "ghp_" + ``` + Global Options ~~~~~~~~~~~~~~ The following options apply to every check sources. You can use them in any