From 83611592db62a115a4ed6c4d757475bb64fa08b3 Mon Sep 17 00:00:00 2001 From: Jan <96944229+modelrailroader@users.noreply.github.com> Date: Sun, 11 Jun 2023 12:20:59 +0200 Subject: [PATCH] fix: fixed documentation --- docs/optional-configuration.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/optional-configuration.md b/docs/optional-configuration.md index 346d6cd..4016e76 100644 --- a/docs/optional-configuration.md +++ b/docs/optional-configuration.md @@ -7,15 +7,15 @@ title: Optional Configuration The instance (`new TwoFactorAuth()`) can only be configured by the constructor with the following optional arguments -Argument | Default value | Use -------------------|---------------|----- -`$issuer` | `null` | Will be displayed in the users app as the default issuer name when using QR code to import the secret -`$digits` | `6` | The number of digits the resulting codes will be -`$period` | `30` | The number of seconds a code will be valid -`$algorithm` | `'sha1'` | The algorithm used (one of `sha1`, `sha256`, `sha512`, `md5`) -`$qrcodeprovider` | `null` | QR-code provider -`$rngprovider` | `null` | Random Number Generator provider -`$timeprovider` | `null` | Time provider +Argument | Default value | Use +------------------|-------------------|----- +`$issuer` | `null` | Will be displayed in the users app as the default issuer name when using QR code to import the secret +`$digits` | `6` | The number of digits the resulting codes will be +`$period` | `30` | The number of seconds a code will be valid +`$algorithm` | `Algorithm::Sha1` | The algorithm used (one of `Algorithm::Sha1`, `Algorithm::Sha256`, `Algorithm::Sha512`, `Algorithm::md5`) +`$qrcodeprovider` | `null` | QR-code provider +`$rngprovider` | `null` | Random Number Generator provider +`$timeprovider` | `null` | Time provider **Note:** the default values for `$digits`, `$period`, and `$algorithm` provide the widest variety of support amongst common authenticator apps such as Google Authenticator. If you choose to use different values for these arguments you will likely have to instruct your users to use a specific app which supports your chosen configuration.