summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRob Janssen <rob@devcorner.nl>2014-09-20 02:11:28 +0200
committerRob Janssen <rob@devcorner.nl>2014-09-20 02:11:28 +0200
commitc3629dbb9c0105bddf5875e0f5f98caded86e556 (patch)
treef498f44422e858833ba935a80e702c3be69f1a4d
parentdb7a0e420125587579c0a92f54556978bffebb67 (diff)
downloadTwoFactorAuth-c3629dbb9c0105bddf5875e0f5f98caded86e556.zip
TwoFactorAuth-c3629dbb9c0105bddf5875e0f5f98caded86e556.tar.gz
TwoFactorAuth-c3629dbb9c0105bddf5875e0f5f98caded86e556.tar.bz2
* Clarification
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 958f56b..bc746e8 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,7 @@ Parameter | Default value | Use
`$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
-`$qrcodeprovider` | `null` | QR-code provider
+`$qrcodeprovider` | `null` | QR-code provider (more on this later)
These parameters are all '`write once`'; the class will, for it's lifetime, use these values when generating / calculating codes. The number of digits, the period and algorithm are all set to values Google's Authticator app uses (and supports). You may specify `8` digits, a period of `45` seconds and the `sha256` algorithm but the authenticator app (be it Google's implementation, Authy or any other app) may or may not support these values. Your mileage may vary; keep it on the safe side if you don't have control on the app used by your audience.