Skip to content

Commit 8361159

Browse files
fix: fixed documentation
1 parent dd0ecae commit 8361159

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/optional-configuration.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ title: Optional Configuration
77

88
The instance (`new TwoFactorAuth()`) can only be configured by the constructor with the following optional arguments
99

10-
Argument | Default value | Use
11-
------------------|---------------|-----
12-
`$issuer` | `null` | Will be displayed in the users app as the default issuer name when using QR code to import the secret
13-
`$digits` | `6` | The number of digits the resulting codes will be
14-
`$period` | `30` | The number of seconds a code will be valid
15-
`$algorithm` | `'sha1'` | The algorithm used (one of `sha1`, `sha256`, `sha512`, `md5`)
16-
`$qrcodeprovider` | `null` | QR-code provider
17-
`$rngprovider` | `null` | Random Number Generator provider
18-
`$timeprovider` | `null` | Time provider
10+
Argument | Default value | Use
11+
------------------|-------------------|-----
12+
`$issuer` | `null` | Will be displayed in the users app as the default issuer name when using QR code to import the secret
13+
`$digits` | `6` | The number of digits the resulting codes will be
14+
`$period` | `30` | The number of seconds a code will be valid
15+
`$algorithm` | `Algorithm::Sha1` | The algorithm used (one of `Algorithm::Sha1`, `Algorithm::Sha256`, `Algorithm::Sha512`, `Algorithm::md5`)
16+
`$qrcodeprovider` | `null` | QR-code provider
17+
`$rngprovider` | `null` | Random Number Generator provider
18+
`$timeprovider` | `null` | Time provider
1919

2020
**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.
2121

0 commit comments

Comments
 (0)