mirror of
https://github.com/LanceGin/jsotp.git
synced 2024-10-06 06:22:08 +08:00
upd: README
This commit is contained in:
parent
bfdf7b1962
commit
57d448f534
14
README.md
14
README.md
@ -54,7 +54,7 @@ let jsotp = require('jsotp/totp');
|
||||
let jsotp = require('jsotp');
|
||||
|
||||
// Create TOTP object
|
||||
let totp = jsotp.TOTP.gen('BASE32_ENCODED_SECRET');
|
||||
let totp = jsotp.TOTP('BASE32ENCODEDSECRET');
|
||||
totp.now(); // => 432143
|
||||
|
||||
// Verify for current time
|
||||
@ -71,7 +71,7 @@ totp.verify(432143); // => false
|
||||
let jsotp = require('jsotp');
|
||||
|
||||
// Create HOTP object
|
||||
let hotp = jsotp.HOTP.gen('BASE32_ENCODED_SECRET');
|
||||
let hotp = jsotp.HOTP('BASE32ENCODEDSECRET');
|
||||
hotp.at(0); // => 432143
|
||||
hotp.at(1); // => 231434
|
||||
hotp.at(2132); // => 242432
|
||||
@ -97,14 +97,10 @@ let b32_secret = jsotp.Base32.random_gen();
|
||||
|
||||
#### • jsotp.Util.url_gen
|
||||
|
||||
#### • jsotp.TOTP.gen()
|
||||
|
||||
#### • jsotp.TOTP.now()
|
||||
|
||||
#### • jsotp.TOTP.verify()
|
||||
|
||||
#### • jsotp.HOTP.gen()
|
||||
|
||||
#### • jsotp.HOTP.at()
|
||||
|
||||
#### • jsotp.HOTP.verify()
|
||||
@ -124,5 +120,11 @@ npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
* Unit test
|
||||
|
||||
```shell
|
||||
npm test
|
||||
```
|
||||
|
||||
### [中文文档](docs/README_zh.md)
|
||||
|
||||
|
@ -54,7 +54,7 @@ let jsotp = require('jsotp/totp');
|
||||
let jsotp = require('jsotp');
|
||||
|
||||
// Create TOTP object
|
||||
let totp = jsotp.TOTP.gen('BASE32_ENCODED_SECRET');
|
||||
let totp = jsotp.TOTP('BASE32ENCODEDSECRET');
|
||||
totp.now(); // => 432143
|
||||
|
||||
// Verify for current time
|
||||
@ -71,7 +71,7 @@ totp.verify(432143); // => false
|
||||
let jsotp = require('jsotp');
|
||||
|
||||
// Create HOTP object
|
||||
let hotp = jsotp.HOTP.gen('BASE32_ENCODED_SECRET');
|
||||
let hotp = jsotp.HOTP('BASE32ENCODEDSECRET');
|
||||
hotp.at(0); // => 432143
|
||||
hotp.at(1); // => 231434
|
||||
hotp.at(2132); // => 242432
|
||||
@ -97,14 +97,10 @@ let b32_secret = jsotp.Base32.random_gen();
|
||||
|
||||
#### • jsotp.Util.url_gen
|
||||
|
||||
#### • jsotp.TOTP.gen()
|
||||
|
||||
#### • jsotp.TOTP.now()
|
||||
|
||||
#### • jsotp.TOTP.verify()
|
||||
|
||||
#### • jsotp.HOTP.gen()
|
||||
|
||||
#### • jsotp.HOTP.at()
|
||||
|
||||
#### • jsotp.HOTP.verify()
|
||||
@ -124,4 +120,10 @@ npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
* 单元测试
|
||||
|
||||
```shell
|
||||
npm test
|
||||
```
|
||||
|
||||
### [README](../README.md)
|
Loading…
Reference in New Issue
Block a user