docs: add info about related packages

inway · Sep 6, 2023 · 9375bea · 9375bea
1 parent 6ff6182
commit 9375bea
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -16,14 +16,14 @@ rewrite of the original library [zxcvbn](https://github.com/dropbox/zxcvbn) from
 
 This is a melos managed monorepo containing the following packages:
 
-| Package                     | Status                | Details                                                                                                              |
-| --------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------- |
-| dart_zxcvbn                 | Partially implemented | [README](packages/dart_zxcvbn/README.md) [pub](https://pub.dev/packages/dart_zxcvbn)                                 |
-| dart_zxcvbn_language_common |                       | [README](packages/dart_zxcvbn_language_common/README.md) [pub](https://pub.dev/packages/dart_zxcvbn_language_common) |
-| dart_zxcvbn_language_en     |                       | [README](packages/dart_zxcvbn_language_en/README.md) [pub](https://pub.dev/packages/dart_zxcvbn_language_en)         |
-| dart_zxcvbn_language_pl     |                       | [README](packages/dart_zxcvbn_language_pl/README.md) [pub](https://pub.dev/packages/dart_zxcvbn_language_pl)         |
-| dart_zxcvbn_tools           | Internal use helpers  | [README](packages/dart_zxcvbn_tools/README.md) [pub](https://pub.dev/packages/dart_zxcvbn_tools)                     |
-| flutter_password_scoring    | Mostly implemented    | [README](packages/flutter_password_scoring/README.md) [pub](https://pub.dev/packages/flutter_password_scoring)       |
+| Package                     | Status                | Details                                                                                                                 |
+| --------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| dart_zxcvbn                 | Partially implemented | [README](packages/dart_zxcvbn/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn)                                 |
+| dart_zxcvbn_language_common |                       | [README](packages/dart_zxcvbn_language_common/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_common) |
+| dart_zxcvbn_language_en     |                       | [README](packages/dart_zxcvbn_language_en/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_en)         |
+| dart_zxcvbn_language_pl     |                       | [README](packages/dart_zxcvbn_language_pl/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_pl)         |
+| dart_zxcvbn_tools           | Internal use helpers  | [README](packages/dart_zxcvbn_tools/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_tools)                     |
+| flutter_password_scoring    | Mostly implemented    | [README](packages/flutter_password_scoring/README.md) \| [pub](https://pub.dev/packages/flutter_password_scoring)       |
 
 ## Credits
 

diff --git a/packages/dart_zxcvbn/README.md b/packages/dart_zxcvbn/README.md
@@ -36,16 +36,13 @@ final result = zxcvbn('test');
 
 ## Related packages
 
-This is a melos managed monorepo containing the following packages:
-
-| Package                     | Details                                                                                                              |
-| --------------------------- | -------------------------------------------------------------------------------------------------------------------- |
-| dart_zxcvbn                 | [README](packages/dart_zxcvbn/README.md) [pub](https://pub.dev/packages/dart_zxcvbn)                                 |
-| dart_zxcvbn_language_common | [README](packages/dart_zxcvbn_language_common/README.md) [pub](https://pub.dev/packages/dart_zxcvbn_language_common) |
-| dart_zxcvbn_language_en     | [README](packages/dart_zxcvbn_language_en/README.md) [pub](https://pub.dev/packages/dart_zxcvbn_language_en)         |
-| dart_zxcvbn_language_pl     | [README](packages/dart_zxcvbn_language_pl/README.md) [pub](https://pub.dev/packages/dart_zxcvbn_language_pl)         |
-| dart_zxcvbn_tools           | [README](packages/dart_zxcvbn_tools/README.md) [pub](https://pub.dev/packages/dart_zxcvbn_tools)                     |
-| flutter_password_scoring    | [README](packages/flutter_password_scoring/README.md) [pub](https://pub.dev/packages/flutter_password_scoring)       |
+| Package                     | Details                                                                                                                 |
+| --------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| dart_zxcvbn                 | [README](packages/dart_zxcvbn/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn)                                 |
+| dart_zxcvbn_language_common | [README](packages/dart_zxcvbn_language_common/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_common) |
+| dart_zxcvbn_language_en     | [README](packages/dart_zxcvbn_language_en/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_en)         |
+| dart_zxcvbn_language_pl     | [README](packages/dart_zxcvbn_language_pl/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_pl)         |
+| flutter_password_scoring    | [README](packages/flutter_password_scoring/README.md) \| [pub](https://pub.dev/packages/flutter_password_scoring)       |
 
 ## TODO
 

diff --git a/packages/dart_zxcvbn_language_common/README.md b/packages/dart_zxcvbn_language_common/README.md
@@ -16,6 +16,16 @@ rewrite of the original library [zxcvbn](https://github.com/dropbox/zxcvbn) from
 
 Please refer to documentation from [root package](https://github.com/inway/dart_zxcvbn).
 
+## Related packages
+
+| Package                     | Details                                                                                                                 |
+| --------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| dart_zxcvbn                 | [README](packages/dart_zxcvbn/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn)                                 |
+| dart_zxcvbn_language_common | [README](packages/dart_zxcvbn_language_common/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_common) |
+| dart_zxcvbn_language_en     | [README](packages/dart_zxcvbn_language_en/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_en)         |
+| dart_zxcvbn_language_pl     | [README](packages/dart_zxcvbn_language_pl/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_pl)         |
+| flutter_password_scoring    | [README](packages/flutter_password_scoring/README.md) \| [pub](https://pub.dev/packages/flutter_password_scoring)       |
+
 ## License
 
 - see [LICENSE](https://github.com/inway/dart_zxcvbn/LICENSE)
diff --git a/packages/dart_zxcvbn_language_en/README.md b/packages/dart_zxcvbn_language_en/README.md
@@ -16,6 +16,16 @@ rewrite of the original library [zxcvbn](https://github.com/dropbox/zxcvbn) from
 
 Please refer to documentation from [root package](https://github.com/inway/dart_zxcvbn).
 
+## Related packages
+
+| Package                     | Details                                                                                                                 |
+| --------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| dart_zxcvbn                 | [README](packages/dart_zxcvbn/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn)                                 |
+| dart_zxcvbn_language_common | [README](packages/dart_zxcvbn_language_common/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_common) |
+| dart_zxcvbn_language_en     | [README](packages/dart_zxcvbn_language_en/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_en)         |
+| dart_zxcvbn_language_pl     | [README](packages/dart_zxcvbn_language_pl/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_pl)         |
+| flutter_password_scoring    | [README](packages/flutter_password_scoring/README.md) \| [pub](https://pub.dev/packages/flutter_password_scoring)       |
+
 ## License
 
 - see [LICENSE](https://github.com/inway/dart_zxcvbn/LICENSE)
diff --git a/packages/dart_zxcvbn_language_pl/README.md b/packages/dart_zxcvbn_language_pl/README.md
@@ -16,6 +16,16 @@ rewrite of the original library [zxcvbn](https://github.com/dropbox/zxcvbn) from
 
 Please refer to documentation from [root package](https://github.com/inway/dart_zxcvbn).
 
+## Related packages
+
+| Package                     | Details                                                                                                                 |
+| --------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| dart_zxcvbn                 | [README](packages/dart_zxcvbn/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn)                                 |
+| dart_zxcvbn_language_common | [README](packages/dart_zxcvbn_language_common/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_common) |
+| dart_zxcvbn_language_en     | [README](packages/dart_zxcvbn_language_en/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_en)         |
+| dart_zxcvbn_language_pl     | [README](packages/dart_zxcvbn_language_pl/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_pl)         |
+| flutter_password_scoring    | [README](packages/flutter_password_scoring/README.md) \| [pub](https://pub.dev/packages/flutter_password_scoring)       |
+
 ## License
 
 - see [LICENSE](https://github.com/inway/dart_zxcvbn/LICENSE)
diff --git a/packages/dart_zxcvbn_tools/README.md b/packages/dart_zxcvbn_tools/README.md
@@ -9,7 +9,7 @@
 
 ## Description
 
-This package is a Dart port of
+This package is a part of Dart port of
 [@zxcvbn-ts/zxcvbn](https://github.com/zxcvbn-ts/zxcvbn), which is a Typescript
 rewrite of the original library [zxcvbn](https://github.com/dropbox/zxcvbn) from
 [Dropbox](https://github.com/dropbox).

diff --git a/packages/flutter_password_scoring/README.md b/packages/flutter_password_scoring/README.md
@@ -85,6 +85,16 @@ facade for `StreamBuilder`), and that's where the widget tree is constructed.
    );
    ```
 
+## Related packages
+
+| Package                     | Details                                                                                                                 |
+| --------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| dart_zxcvbn                 | [README](packages/dart_zxcvbn/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn)                                 |
+| dart_zxcvbn_language_common | [README](packages/dart_zxcvbn_language_common/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_common) |
+| dart_zxcvbn_language_en     | [README](packages/dart_zxcvbn_language_en/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_en)         |
+| dart_zxcvbn_language_pl     | [README](packages/dart_zxcvbn_language_pl/README.md) \| [pub](https://pub.dev/packages/dart_zxcvbn_language_pl)         |
+| flutter_password_scoring    | [README](packages/flutter_password_scoring/README.md) \| [pub](https://pub.dev/packages/flutter_password_scoring)       |
+
 ## License
 
 - see [LICENSE](https://github.com/inway/dart_zxcvbn/LICENSE)