Add common readme and updates (#68)

leancodepl · Sep 29, 2023 · 4fa6ec2 · 4fa6ec2
1 parent acc12da
commit 4fa6ec2
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 4 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-* @iasiu
+* @lewandowski-jan
diff --git a/README.md b/README.md
@@ -1,3 +1,27 @@
 # comms
 
-Simple communication pattern abstraction on streams.
+Predictable and simple communication pattern between classes.
+
+| Package                                               |                    Documentation                     |                                                       pub                                                       |                                        CI                                        |
+| ----------------------------------------------------- | :--------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------: |
+| [`comms`][comms-link]                                   |         [Documentation][comms-documentation]          |                          [![comms pub.dev badge][comms-pub-badge]][comms-pub-badge-link]                           |                  [![][comms-build-badge]][comms-build-badge-link]                  |
+| [`flutter_comms`][flutter_comms-link]                   |     [Documentation][flutter_comms-documentation]      |              [![flutter_comms pub.dev badge][flutter_comms-pub-badge]][flutter_comms-pub-badge-link]               |          [![][flutter_comms-build-badge]][flutter_comms-build-badge-link]          |
+
+## Maintainers
+
+- [Jan Lewandowski](https://github.com/lewandowski-jan)
+
+
+[comms-link]: https://github.com/leancodepl/comms/tree/master/packages/comms
+[comms-documentation]: https://pub.dev/documentation/comms/latest/
+[comms-pub-badge]: https://img.shields.io/pub/v/comms
+[comms-pub-badge-link]: https://pub.dev/packages/comms
+[comms-build-badge]: https://img.shields.io/github/actions/workflow/status/leancodepl/comms/comms-prepare.yaml?branch=master
+[comms-build-badge-link]: https://github.com/leancodepl/comms/actions/workflows/comms-prepare.yaml
+
+[flutter_comms-link]: https://github.com/leancodepl/comms/tree/master/packages/flutter_comms
+[flutter_comms-documentation]: https://pub.dev/documentation/flutter_comms/latest/
+[flutter_comms-pub-badge]: https://img.shields.io/pub/v/flutter_comms
+[flutter_comms-pub-badge-link]: https://pub.dev/packages/flutter_comms
+[flutter_comms-build-badge]: https://img.shields.io/github/actions/workflow/status/leancodepl/comms/flutter_comms-prepare.yaml?branch=master
+[flutter_comms-build-badge-link]: https://github.com/leancodepl/comms/actions/workflows/flutter_comms-prepare.yaml
diff --git a/packages/comms/README.md b/packages/comms/README.md
@@ -1,6 +1,6 @@
 # comms
 
-[![codestyle][pub_badge_style]][pub_badge_link]
+[![comms-pub-badge]][comms-pub-badge-link] [![comms-build-badge]][comms-build-badge-link] [![codestyle][pub_badge_style]][pub_badge_link]
 
 `comms` is a simple communication pattern abstraction on streams, created for
 communication between any classes. It allows `Listener`s to easily react to
@@ -290,6 +290,11 @@ void main() async {
 }
 ```
 
+
+[comms-pub-badge]: https://img.shields.io/pub/v/comms
+[comms-pub-badge-link]: https://pub.dev/packages/comms
+[comms-build-badge]: https://img.shields.io/github/actions/workflow/status/leancodepl/comms/comms-prepare.yaml?branch=master
+[comms-build-badge-link]: https://github.com/leancodepl/comms/actions/workflows/comms-prepare.yaml
 [pub_badge_style]: https://img.shields.io/badge/style-leancode__lint-black
 [pub_badge_link]: https://pub.dartlang.org/packages/leancode_lint
 [flutter_comms]: https://pub.dev/packages/flutter_comms
diff --git a/packages/flutter_comms/README.md b/packages/flutter_comms/README.md
@@ -1,6 +1,6 @@
 # flutter_comms
 
-[![codestyle][pub_badge_style]][pub_badge_link]
+[![flutter_comms-pub-badge]][flutter_comms-pub-badge-link] [![flutter_comms-build-badge]][flutter_comms-build-badge-link] [![codestyle][pub_badge_style]][pub_badge_link]
 
 `flutter_comms` builds on top of [comms], making it easier to implement comms pattern
 in Flutter projects.
@@ -76,6 +76,11 @@ Widget build(BuildContext context) {
 }
 ```
 
+
+[flutter_comms-pub-badge]: https://img.shields.io/pub/v/flutter_comms
+[flutter_comms-pub-badge-link]: https://pub.dev/packages/flutter_comms
+[flutter_comms-build-badge]: https://img.shields.io/github/actions/workflow/status/leancodepl/comms/flutter_comms-prepare.yaml?branch=master
+[flutter_comms-build-badge-link]: https://github.com/leancodepl/comms/actions/workflows/flutter_comms-prepare.yaml
 [pub_badge_style]: https://img.shields.io/badge/style-leancode__lint-black
 [pub_badge_link]: https://pub.dartlang.org/packages/leancode_lint
 [comms]: https://pub.dev/packages/comms