Merge pull request #110 from modelrailroader/patch-1

Fix docs: Construct new TwoFactorAuth-class
RobThree · Jul 29, 2023 · 9476751 · 9476751
2 parents 63b49ce + 0565d63
commit 9476751
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 19 deletions.
diff --git 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.
 

diff --git a/docs/qr-codes.md b/docs/qr-codes.md
@@ -20,19 +20,19 @@ You can also specify a size as a third argument which is 200 by default.
 
 ## Online Providers
 
-[QRServerProvider](qr-codes/qr-server.html) (default)
+[QRServerProvider](qr-codes/qr-server.md) (default)
 
 **Warning:** Whilst it is the default, this provider is not suggested for applications where absolute security is needed, because it uses an external service for the QR code generation. You can make use of the included offline providers listed below which generate locally.
 
-[ImageChartsQRCodeProvider](qr-codes/image-charts.html)
+[ImageChartsQRCodeProvider](qr-codes/image-charts.md)
 
-[QRicketProvider](qr-codes/qrickit.html)
+[QRicketProvider](qr-codes/qrickit.md)
 
 ## Offline Providers
 
-[EndroidQrCodeProvider](qr-codes/endroid.html) and EndroidQrCodeWithLogoProvider
+[EndroidQrCodeProvider](qr-codes/endroid.md) and EndroidQrCodeWithLogoProvider
 
-[BaconQRCodeProvider](qr-codes/bacon.html)
+[BaconQRCodeProvider](qr-codes/bacon.md)
 
 **Note:** offline providers may have additional PHP requirements in order to function, you should study what is required before trying to make use of them.
 
@@ -52,11 +52,8 @@ use RobThree\Auth\TwoFactorAuth;
 $qrCodeProvider = new YourChosenProvider();
 
 $tfa = new TwoFactorAuth(
-	null,
-	6,
-	30,
-	'sha1',
-	$qrCodeProvider
+	issuer: "Your Company Or App Name",
+ 	qrcodeprovider: $qrCodeProvider
 );
 ```