From 1df673076ecc6550b18058a036f409d30a4a5cce Mon Sep 17 00:00:00 2001 From: Gonzalo Uceda Date: Fri, 27 Oct 2023 09:59:19 +0200 Subject: [PATCH] docs: bring back `alpha` disclaimer --- README.md | 3 +++ packages/code/README.md | 3 +++ packages/core/README.md | 3 +++ packages/datetime/README.md | 3 +++ packages/form/README.md | 3 +++ packages/table/README.md | 2 +- 6 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ce14f2b45..c1a6ea3cd 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@ Monorepo containing the codebase for the Genesys UI components library. +> **Warning** +> This is an `alpha` version and it is not yet production ready. + The project is built using `npm workspaces` and includes the following packages: [![npm version](https://img.shields.io/npm/v/@devoinc/genesys-ui/latest?label=%40devoinc%2Fgenesys-ui@latest)](https://www.npmjs.com/package/@devoinc/genesys-ui) diff --git a/packages/code/README.md b/packages/code/README.md index 44713d617..acc0a95e8 100644 --- a/packages/code/README.md +++ b/packages/code/README.md @@ -1,5 +1,8 @@ # Genesys UI Code +> **Warning** +> This is an `alpha` version and it is not yet production ready. + This package contains components for code editing and visualization. It belongs to the [Genesys UI](https://github.com/DevoInc/genesys-ui) component library and is built on top of the [core](https://github.com/DevoInc/genesys-ui/tree/master/packages/core) package. This package contains the following components: diff --git a/packages/core/README.md b/packages/core/README.md index e2cca6e4b..eb5969e4f 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,5 +1,8 @@ # Genesys UI Core +> **Warning** +> This is an `alpha` version and it is not yet production ready. + Core package for the Genesys UI component library. It contains the base components of the library, and is a dependency of `genesys-ui-form` and `genesys-ui-datetime`. Among others, this package contains the following components: diff --git a/packages/datetime/README.md b/packages/datetime/README.md index 0ecc5544c..f149bce6e 100644 --- a/packages/datetime/README.md +++ b/packages/datetime/README.md @@ -1,5 +1,8 @@ # Genesys UI Datetime +> **Warning** +> This is an `alpha` version and it is not yet production ready. + Package containing a set of components for date and time selection. It belongs to the [Genesys UI](https://github.com/DevoInc/genesys-ui) component library and is built on top of the [core](https://github.com/DevoInc/genesys-ui/tree/master/packages/core) package. Among others, this package contains the following components: diff --git a/packages/form/README.md b/packages/form/README.md index 72b586bde..f58d803cf 100644 --- a/packages/form/README.md +++ b/packages/form/README.md @@ -1,5 +1,8 @@ # Genesys UI Form +> **Warning** +> This is an `alpha` version and it is not yet production ready. + Package containing a set of components for form handling. It belongs to the [Genesys UI](https://github.com/DevoInc/genesys-ui) component library and is built on top of the [core](https://github.com/DevoInc/genesys-ui/tree/master/packages/core) package. Among others, this package contains the following components: diff --git a/packages/table/README.md b/packages/table/README.md index bf390d31a..f658443d9 100644 --- a/packages/table/README.md +++ b/packages/table/README.md @@ -1,7 +1,7 @@ # Genesys UI Table > **Warning** -> This package is still under development and is not ready for production use. +> This package is still under development and is not yet production ready. This package contains the `Table` component. It belongs to the [Genesys UI](https://github.com/DevoInc/genesys-ui) component library and is built on top of the [core](https://github.com/DevoInc/genesys-ui/tree/master/packages/core) package.