public/jsotp-ts
public/jsotp-ts
9
0
Fork 0
forked from github/jsotp
Code Issues Pull Requests Packages Projects Releases Wiki Activity

upd: README

Browse Source
This commit is contained in:
lancegin 2017-06-29 15:32:08 +08:00
parent bfdf7b1962
commit 57d448f534
2 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -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)

14
docs/README_zh.md
View File

@ -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)