From 92ad356f732fb96d97168f3ce42720931d2c6277 Mon Sep 17 00:00:00 2001 From: lancegin Date: Mon, 10 Jul 2017 12:26:13 +0800 Subject: [PATCH] upd: README --- README.md | 30 ++++++++++++++++++++++++++++-- docs/README_zh.md | 30 ++++++++++++++++++++++++++++-- 2 files changed, 56 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0ceb403..05718ce 100644 --- a/README.md +++ b/README.md @@ -87,8 +87,13 @@ let b32_secret = jsotp.Base32.random_gen(); return: String desc: the length of random base32 encoded string. -#### • jsotp.Util.url_gen() - +#### • [jsotp.TOTP(secret)](https://github.com/LanceGin/jsotp/blob/master/src/jsotp.js#L48) + + param: secret + type: string + return: TOTP + desc: generate TOTP instance. + #### • [jsotp.TOTP.now()](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L38) return: String @@ -100,7 +105,21 @@ let b32_secret = jsotp.Base32.random_gen(); type: string return: Boolean desc: verify the totp code. + +#### • [jsotp.TOTP.url_gen(issuer)](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L94) + param: issuer + type: string + return: string + desc: generate url with TOTP instance + +#### • [jsotp.HOTP(secret)](https://github.com/LanceGin/jsotp/blob/master/src/jsotp.js#L47) + + param: secret + type: string + return: HOTP + desc: generate HOTP instance. + #### • [jsotp.HOTP.at(counter)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L24) param: counter @@ -117,6 +136,13 @@ let b32_secret = jsotp.Base32.random_gen(); return: Boolean desc: verify the hotp code. +#### • [jsotp.HOTP.url_gen(issuer)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L69) + + param: issuer + type: string + return: string + desc: generate url with HOTP instance + ### Contribute * Clone repo and install dependencies diff --git a/docs/README_zh.md b/docs/README_zh.md index a3f0d7e..ac1452e 100644 --- a/docs/README_zh.md +++ b/docs/README_zh.md @@ -87,8 +87,13 @@ let b32_secret = jsotp.Base32.random_gen(); return: String desc: the length of random base32 encoded string. -#### • jsotp.Util.url_gen() - +#### • [jsotp.TOTP(secret)](https://github.com/LanceGin/jsotp/blob/master/src/jsotp.js#L48) + + param: secret + type: string + return: TOTP + desc: generate TOTP instance. + #### • [jsotp.TOTP.now()](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L38) return: String @@ -100,7 +105,21 @@ let b32_secret = jsotp.Base32.random_gen(); type: string return: Boolean desc: verify the totp code. + +#### • [jsotp.TOTP.url_gen(issuer)](https://github.com/LanceGin/jsotp/blob/master/src/totp.js#L94) + param: issuer + type: string + return: string + desc: generate url with TOTP instance + +#### • [jsotp.HOTP(secret)](https://github.com/LanceGin/jsotp/blob/master/src/jsotp.js#L47) + + param: secret + type: string + return: HOTP + desc: generate HOTP instance. + #### • [jsotp.HOTP.at(counter)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L24) param: counter @@ -117,6 +136,13 @@ let b32_secret = jsotp.Base32.random_gen(); return: Boolean desc: verify the hotp code. +#### • [jsotp.HOTP.url_gen(issuer)](https://github.com/LanceGin/jsotp/blob/master/src/hotp.js#L69) + + param: issuer + type: string + return: string + desc: generate url with HOTP instance + ### 开发 * 克隆代码并安装依赖