Skip to content

Commit

Permalink
chore: update readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
yeojz committed Dec 30, 2019
1 parent 3f11c3f commit 93e6ef8
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 9 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -517,6 +517,7 @@ specification. Contributions of any kind welcome!

<!-- Project Links -->

[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
Expand Down
4 changes: 4 additions & 0 deletions packages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- TOC depthFrom:2 -->

- [Core](#core)
Expand Down Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/otplib-plugin-base32-enc-dec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/otplib-plugin-crypto-async-ronomon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/otplib-plugin-crypto-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/otplib-plugin-crypto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/otplib-plugin-thirty-two/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/otplib-preset-default-async/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/otplib-preset-default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/otplib-preset-v11/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 93e6ef8

Please sign in to comment.