From 93e6ef8561d72e31f9c86b45c16b3d960bbd0646 Mon Sep 17 00:00:00 2001 From: Gerald Yeo Date: Mon, 30 Dec 2019 23:36:50 +0800 Subject: [PATCH] chore: update readme links --- README.md | 3 ++- packages/README.md | 4 ++++ packages/otplib-plugin-base32-enc-dec/README.md | 2 +- packages/otplib-plugin-crypto-async-ronomon/README.md | 2 +- packages/otplib-plugin-crypto-js/README.md | 2 +- packages/otplib-plugin-crypto/README.md | 2 +- packages/otplib-plugin-thirty-two/README.md | 2 +- packages/otplib-preset-default-async/README.md | 2 +- packages/otplib-preset-default/README.md | 2 +- packages/otplib-preset-v11/README.md | 2 +- 10 files changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3aa0aef2..f286a3fd 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ and includes additional methods to allow you to work with Google Authenticator. ## Quick Start > If you need to customise your base32 or crypto libraries, -> check out the [In-Depth Guide][docs-in-depth] +> check out the [In-Depth Guide][docs-in-depth] and [Available Packages][docs-available-packages] ### In Node.js @@ -517,6 +517,7 @@ specification. Contributions of any kind welcome! +[docs-available-packages]: https://github.com/yeojz/otplib/blob/master/packages/README.md [docs-core-async]: https://github.com/yeojz/otplib/blob/master/packages/otplib-core-async/README.md [docs-in-depth]: https://github.com/yeojz/otplib/blob/master/packages/otplib-core/README.md#getting-started [docs-preset-browser-src]: https://github.com/yeojz/otplib/blob/master/packages/otplib-preset-browser/src/index.ts diff --git a/packages/README.md b/packages/README.md index ce053f4c..d6ea638c 100644 --- a/packages/README.md +++ b/packages/README.md @@ -6,6 +6,8 @@ All other `otplib-*` libraries that are not scoped are not maintained under this Packages are classified into 3 categories: `core`, `plugin` and `preset`. +Do refer to the [Quick Start Guide][docs-quick-start] to get started. + - [Core](#core) @@ -80,3 +82,5 @@ Each presets would need the corresponding dependent npm modules to be installed. | [@otplib/preset-default-async](./otplib-preset-default-async) | Async version of `@otplib/preset-default` | | [@otplib/preset-browser](./otplib-preset-browser) | Webpack bundle and is a self contained umd bundle. | | [@otplib/preset-v11](./otplib-preset-v11) | Wrapper to adapt the APIs to v11.x compatible format | + +[docs-quick-start]: https://github.com/yeojz/otplib/blob/master/README.md#quick-start diff --git a/packages/otplib-plugin-base32-enc-dec/README.md b/packages/otplib-plugin-base32-enc-dec/README.md index c68098b8..713b9492 100644 --- a/packages/otplib-plugin-base32-enc-dec/README.md +++ b/packages/otplib-plugin-base32-enc-dec/README.md @@ -16,5 +16,5 @@ npm install --save @otplib/plugin-base32-enc-dec `@otplib/plugin-base32-enc-dec` is [MIT licensed][project-license] [project-license]: https://github.com/yeojz/otplib/blob/master/LICENSE -[project-v-readme]: https://github.com/yeojz/otplib/blob/master/packages/README.md#plugins---base32 +[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md [project-v-site]: https://otplib.yeojz.dev diff --git a/packages/otplib-plugin-crypto-async-ronomon/README.md b/packages/otplib-plugin-crypto-async-ronomon/README.md index 76b69c38..cf2e0fe8 100644 --- a/packages/otplib-plugin-crypto-async-ronomon/README.md +++ b/packages/otplib-plugin-crypto-async-ronomon/README.md @@ -16,5 +16,5 @@ npm install --save @otplib/plugin-crypto-async-ronomon `@otplib/plugin-crypto-async-ronomon` is [MIT licensed][project-license] [project-license]: https://github.com/yeojz/otplib/blob/master/LICENSE -[project-v-readme]: https://github.com/yeojz/otplib/blob/master/packages/README.md#plugins---crypto +[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md [project-v-site]: https://otplib.yeojz.dev diff --git a/packages/otplib-plugin-crypto-js/README.md b/packages/otplib-plugin-crypto-js/README.md index e7186295..924b55b6 100644 --- a/packages/otplib-plugin-crypto-js/README.md +++ b/packages/otplib-plugin-crypto-js/README.md @@ -16,5 +16,5 @@ npm install --save @otplib/plugin-crypto-js `@otplib/plugin-crypto-js` is [MIT licensed][project-license] [project-license]: https://github.com/yeojz/otplib/blob/master/LICENSE -[project-v-readme]: https://github.com/yeojz/otplib/blob/master/packages/README.md#plugins---crypto +[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md [project-v-site]: https://otplib.yeojz.dev diff --git a/packages/otplib-plugin-crypto/README.md b/packages/otplib-plugin-crypto/README.md index 70618485..f853c5ce 100644 --- a/packages/otplib-plugin-crypto/README.md +++ b/packages/otplib-plugin-crypto/README.md @@ -16,5 +16,5 @@ npm install --save @otplib/plugin-crypto `@otplib/plugin-crypto` is [MIT licensed][project-license] [project-license]: https://github.com/yeojz/otplib/blob/master/LICENSE -[project-v-readme]: https://github.com/yeojz/otplib/blob/master/packages/README.md#plugins---crypto +[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md [project-v-site]: https://otplib.yeojz.dev diff --git a/packages/otplib-plugin-thirty-two/README.md b/packages/otplib-plugin-thirty-two/README.md index 2928f6b3..25850eef 100644 --- a/packages/otplib-plugin-thirty-two/README.md +++ b/packages/otplib-plugin-thirty-two/README.md @@ -16,5 +16,5 @@ npm install --save @otplib/plugin-thirty-two `@otplib/plugin-thirty-two` is [MIT licensed][project-license] [project-license]: https://github.com/yeojz/otplib/blob/master/LICENSE -[project-v-readme]: https://github.com/yeojz/otplib/blob/master/packages/README.md#plugins---base32 +[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md [project-v-site]: https://otplib.yeojz.dev diff --git a/packages/otplib-preset-default-async/README.md b/packages/otplib-preset-default-async/README.md index 30feffe2..a6962bd7 100644 --- a/packages/otplib-preset-default-async/README.md +++ b/packages/otplib-preset-default-async/README.md @@ -16,5 +16,5 @@ npm install --save @otplib/preset-default-async `@otplib/preset-default-async` is [MIT licensed][project-license] [project-license]: https://github.com/yeojz/otplib/blob/master/LICENSE -[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md#presets +[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md [project-v-site]: https://otplib.yeojz.dev diff --git a/packages/otplib-preset-default/README.md b/packages/otplib-preset-default/README.md index 96c3c650..4d90bd40 100644 --- a/packages/otplib-preset-default/README.md +++ b/packages/otplib-preset-default/README.md @@ -16,5 +16,5 @@ npm install --save @otplib/preset-default `@otplib/preset-default` is [MIT licensed][project-license] [project-license]: https://github.com/yeojz/otplib/blob/master/LICENSE -[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md#presets +[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md [project-v-site]: https://otplib.yeojz.dev diff --git a/packages/otplib-preset-v11/README.md b/packages/otplib-preset-v11/README.md index 9477e979..f8f0dee3 100644 --- a/packages/otplib-preset-v11/README.md +++ b/packages/otplib-preset-v11/README.md @@ -16,5 +16,5 @@ npm install --save @otplib/preset-v11 `@otplib/preset-v11` is [MIT licensed][project-license] [project-license]: https://github.com/yeojz/otplib/blob/master/LICENSE -[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md#presets +[project-v-readme]: https://github.com/yeojz/otplib/blob/master/README.md [project-v-site]: https://otplib.yeojz.dev