From 57d448f534e60e839d02bf6938eda3704c3b407e Mon Sep 17 00:00:00 2001 From: lancegin Date: Thu, 29 Jun 2017 15:32:08 +0800 Subject: [PATCH] upd: README --- README.md | 14 ++++++++------ docs/README_zh.md | 14 ++++++++------ 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0b8baba..bad08f8 100644 --- a/README.md +++ b/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) diff --git a/docs/README_zh.md b/docs/README_zh.md index aa6a0b5..93da9a4 100644 --- a/docs/README_zh.md +++ b/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) \ No newline at end of file