Skip to content

Commit ff2f13d

Browse files
committed
Move comments above code in README.markdown
1 parent da46519 commit ff2f13d

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

README.markdown

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,14 @@ Who wouldn't love a simple drop-in class for HMAC Based One Time Passwords? It's
1818
```php
1919
use jakobo\HOTP\HOTP;
2020

21-
$result = HOTP::generateByCounter( $key, $counter ); // event based
21+
// event based
22+
$result = HOTP::generateByCounter( $key, $counter );
2223

23-
$result = HOTP::generateByTime( $key, $window ); // time based within a "window" of time
24-
$result = HOTP::generateByTimeWindow( $key, $window, $min, $max ); // same as generateByTime, but for $min windows before and $max windows after
24+
// time based within a "window" of time
25+
$result = HOTP::generateByTime( $key, $window );
26+
27+
// same as generateByTime, but for $min windows before and $max windows after
28+
$result = HOTP::generateByTimeWindow( $key, $window, $min, $max );
2529
```
2630

2731
with `$result`, you can do all sorts of neat things...
@@ -33,5 +37,6 @@ $result->toHex();
3337

3438
$result->doDec();
3539

36-
$result->toHotp( $length ); // how many digits in your OTP?
40+
// how many digits in your OTP?
41+
$result->toHotp( $length );
3742
```

0 commit comments

Comments
 (0)