Skip to content

Commit

Permalink
docs: bring back alpha disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
Gonzalo Uceda committed Oct 27, 2023
1 parent 18c649b commit 1df6730
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
3 changes: 3 additions & 0 deletions packages/code/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 3 additions & 0 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 3 additions & 0 deletions packages/datetime/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 3 additions & 0 deletions packages/form/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion packages/table/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit 1df6730

Please sign in to comment.