doc(README.md): compat info

aegenet · Aug 7, 2024 · 46262db · 46262db
1 parent 4d213d9
commit 46262db
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -4,14 +4,20 @@
 
 # Aurelia 2 - Plugins & Tools monorepo
 
+This repository contains a collection of Aurelia 2 plugins and tools.
+
+**Note**:
+
+- Tested with [`Aurelia v2.0.0-beta.20`](https://github.com/aurelia/aurelia/releases/tag/v2.0.0-beta.20).
+
 ## Plugins
 
-| Name | Usage |
-|--|--|
+| Name                                                                   | Usage                                                          |
+| ---------------------------------------------------------------------- | -------------------------------------------------------------- |
 | [@aegenet/au2-base-component](./packages/au2-base-component/README.md) | Base component with `EventAggregator`, `I18N` and `AntiBounce` |
-| [@aegenet/au2-prism](./packages/au2-prism/README.md) | Prism view and Prism Editor component |
-| [@aegenet/au2-code-mirror](./packages/au2-code-mirror/README.md) | CodeMirror 5 component - Draft only |
-| [@aegenet/au2-code-mirror-5](./packages/au2-code-mirror-5/README.md) | CodeMirror 6+ component - Draft only |
+| [@aegenet/au2-prism](./packages/au2-prism/README.md)                   | Prism view and Prism Editor component                          |
+| [@aegenet/au2-code-mirror](./packages/au2-code-mirror/README.md)       | CodeMirror 5 component - Draft only                            |
+| [@aegenet/au2-code-mirror-5](./packages/au2-code-mirror-5/README.md)   | CodeMirror 6+ component - Draft only                           |
 
 <!-- ## Tools
 
@@ -21,8 +27,8 @@
 
 -->
 
-
 # Coverage
+
 [![codecov](https://codecov.io/gh/aegenet/au2/branch/master/graph/badge.svg?token=DLR66JH77R)](https://codecov.io/gh/aegenet/au2)
 
 ![Coverage sunburst](https://codecov.io/gh/aegenet/au2/branch/master/graphs/sunburst.svg?token=DLR66JH77R)

diff --git a/packages/au2-base-component/README.md b/packages/au2-base-component/README.md
@@ -6,13 +6,14 @@
 > `BaseComponent` with `EventAggregator`, `I18N`, `Aware Event` and `AntiBounce`
 > `BasePage` with `EventAggregator`, `I18N`, `Aware Event` and `AntiBounce`
 
+> Tested with [`Aurelia v2.0.0-beta.20`](https://github.com/aurelia/aurelia/releases/tag/v2.0.0-beta.20).
 
 # Installation
 
 ```shell
-npm install @aegenet/au2-base-component@^1.6.1
+npm install @aegenet/au2-base-component@^2.0.0-alpha
 # or
-yarn add @aegenet/au2-base-component@^1.6.1
+yarn add @aegenet/au2-base-component@^2.0.0-alpha
 ```
 
 # Usage

diff --git a/packages/au2-code-mirror-5/README.md b/packages/au2-code-mirror-5/README.md
@@ -5,12 +5,14 @@
 
 > *DRAFT* Aurelia 2 component: CodeMirror 5.
 
+> Tested with [`Aurelia v2.0.0-beta.20`](https://github.com/aurelia/aurelia/releases/tag/v2.0.0-beta.20).
+
 # Installation
 
 ```shell
-npm install @aegenet/au2-code-mirror-5@^1.6.1
+npm install @aegenet/au2-code-mirror-5@^2.0.0-alpha
 # or
-yarn add @aegenet/au2-code-mirror-5@^1.6.1
+yarn add @aegenet/au2-code-mirror-5@^2.0.0-alpha
 ```
 
 # Usage

diff --git a/packages/au2-code-mirror/README.md b/packages/au2-code-mirror/README.md
@@ -5,12 +5,14 @@
 
 > *DRAFT* Aurelia 2 component: CodeMirror 6+.
 
+> Tested with [`Aurelia v2.0.0-beta.20`](https://github.com/aurelia/aurelia/releases/tag/v2.0.0-beta.20).
+
 # Installation
 
 ```shell
-npm install @aegenet/au2-code-mirror@^1.6.1
+npm install @aegenet/au2-code-mirror@^2.0.0-alpha
 # or
-yarn add @aegenet/au2-code-mirror@^1.6.1
+yarn add @aegenet/au2-code-mirror@^2.0.0-alpha
 ```
 
 # Usage

diff --git a/packages/au2-prism/README.md b/packages/au2-prism/README.md
@@ -9,12 +9,14 @@
 
 > Missing a lot of tests in our implementation! (see: https://github.com/koca/vue-prism-editor/blob/master/packages/vue-prism-editor/tests/Editor.spec.ts for base of tests)
 
+> Tested with [`Aurelia v2.0.0-beta.20`](https://github.com/aurelia/aurelia/releases/tag/v2.0.0-beta.20).
+
 # Installation
 
 ```shell
-npm install @aegenet/au2-prism@^1.6.1
+npm install @aegenet/au2-prism@^2.0.0-alpha
 # or
-yarn add @aegenet/au2-prism@^1.6.1
+yarn add @aegenet/au2-prism@^2.0.0-alpha
 ```
 
 # Usage