Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
* More comprehensive code example. Includes details in how to
  retrieve the generated secret, and how to create OTP object
  from the stored secret.
  • Loading branch information
yookoala committed Aug 14, 2020
1 parent f44cce5 commit 1492ddc
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,16 @@ To create an OTP object, just use the static `create` method. Your object will b
<?php
use OTPHP\TOTP;

// A random secret will be generated from this.
// You should store the secret with the user for verification.
$otp = TOTP::create();
echo 'The current OTP is: '.$otp->now();
echo "The OTP secret is: {$otp->getSecret()}\n";

// Note: use your own way to load the user secret.
// The function "load_user_secret" is simply a placeholder.
$secret = load_user_secret();
$otp = TOTP::create($secret);
echo "The current OTP is: {$otp->now()}\n";
```

In the example above, we use the `TOTP` class, but you can use the `HOTP` one the same way.
Expand All @@ -69,7 +77,11 @@ You can use the provisioning Uri (`$otp->getProvisioningUri();`) as QR Code inpu
We recommend you to use your own QR Code generator (e.g. [BaconQrCode](https://packagist.org/packages/bacon/bacon-qr-code) or [endroid/qr-code](https:/endroid/qr-code)).

```php
$grCodeUri = $totp->getQrCodeUri(
<?php

// Note: You must set label before generating the QR code
$otp->setLabel('Label of your web');
$grCodeUri = $otp->getQrCodeUri(
'https://api.qrserver.com/v1/create-qr-code/?data=[DATA]&size=300x300&ecc=M',
'[DATA]'
);
Expand All @@ -79,6 +91,7 @@ echo "<img src='{$grCodeUri}'>";
Now that your applications are configured, you can verify the generated OTPs:

```php
$otp = TOTP::create($secret); // create TOTP object from the secret.
$otp->verify($input); // Returns true if the input is verified, otherwise false.
```

Expand Down

0 comments on commit 1492ddc

Please sign in to comment.