update packages readmes

README.md

@@ -47,17 +47,18 @@ Try our pre-configured template on
 
 ## Packages
 
-| Project                                                                  | Status                                                                                                                      | Description                                                                  |
-|--------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|
-| [@epam/uui](https://github.com/epam/UUI/tree/main/uui)                   | [![npm version](https://badge.fury.io/js/@epam%2Fuui.svg)](https://www.npmjs.com/package/@epam%2Fuui)                       | Contains a core parts of the UUI library                                     |
-| [@epam/uui-components](https://github.com/epam/UUI/tree/main/uui-components) | [![npm version](https://badge.fury.io/js/@epam%2Fuui-components.svg)](https://www.npmjs.com/package/@epam%2Fuui-components) | Set of headless core components                                              |
-| [@epam/loveship](https://github.com/epam/UUI/tree/main/loveship)         | [![npm version](https://badge.fury.io/js/@epam%2Floveship.svg)](https://www.npmjs.com/package/@epam%2Floveship)             | styled set of components in UUI3 (Loveship) style                            |
-| [@epam/promo](https://github.com/epam/UUI/tree/main/epam-promo)          | [![npm version](https://badge.fury.io/js/@epam%2Fpromo.svg)](https://www.npmjs.com/package/@epam%2Fpromo)                   | styled set of components in UUI4 (Promo) style                               |
-| [@epam/assets](https://github.com/epam/UUI/tree/main/epam-assets)        | [![npm version](https://badge.fury.io/js/@epam%2Fassets.svg)](https://www.npmjs.com/package/@epam%2Fassets)                 | contains icons set, fonts, scss/less global variables and common mixins      |
-| [@epam/uui-editor](https://github.com/epam/UUI/tree/main/uui-editor)     | [![npm version](https://badge.fury.io/js/@epam%2Fuui-editor.svg)](https://www.npmjs.com/package/@epam%2Fuui-editor)         | [Slate.js](https://www.slatejs.org/)-based Rich Text Editor                  |
-| [@epam/uui-db](https://github.com/epam/UUI/tree/main/uui-db)             | [![npm version](https://badge.fury.io/js/@epam%2Fuui-db.svg)](https://www.npmjs.com/package/@epam%2Fuui-db)                 | State-manager, allow to manage UI operations asynchronously.                 |
-| [@epam/uui-timeline](https://github.com/epam/UUI/tree/main/uui-timeline) | [![npm version](https://badge.fury.io/js/@epam%2Fuui-timeline.svg)](https://www.npmjs.com/package/@epam%2Fuui-timeline)     | UUI Timeline provides facilities to build a Ghant-chart like interfaces.     |
-| [@epam/uui-test-utils](https://github.com/epam/UUI/tree/main/test-utils) | [![npm version](https://badge.fury.io/js/@epam%2Fuui-test-utils.svg)](https://www.npmjs.com/package/@epam%2Fuui-test-utils) | A set of helpers which facilitate creation of unit tests for UUI components. |
+| Project                                                                      | Status                                                                                                                      | Description                                                                  |
+|------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|
+| [@epam/uui](https://github.com/epam/UUI/tree/main/uui)                       | [![npm version](https://badge.fury.io/js/@epam%2Fuui.svg)](https://www.npmjs.com/package/@epam%2Fuui)                       | A set of themable components                                                 |
+| [@epam/uui-components](https://github.com/epam/UUI/tree/main/uui-components) | [![npm version](https://badge.fury.io/js/@epam%2Fuui-components.svg)](https://www.npmjs.com/package/@epam%2Fuui-components) | A set of headless core components                                            |
+| [@epam/uui-core](https://github.com/epam/UUI/tree/main/uui-core)             | [![npm version](https://badge.fury.io/js/@epam%2Fuui-core.svg)](https://www.npmjs.com/package/@epam%2Fuui)                  | Core parts of the UUI library                                                |
+| [@epam/loveship](https://github.com/epam/UUI/tree/main/loveship)             | [![npm version](https://badge.fury.io/js/@epam%2Floveship.svg)](https://www.npmjs.com/package/@epam%2Floveship)             | Styled set of components in Loveship style                                   |
+| [@epam/electric](https://github.com/epam/UUI/tree/main/electric)             | [![npm version](https://badge.fury.io/js/@epam%2Floveship.svg)](https://www.npmjs.com/package/@epam%2Floveship)             | Styled set of components in Electric style                                   |
+| [@epam/promo](https://github.com/epam/UUI/tree/main/epam-promo)              | [![npm version](https://badge.fury.io/js/@epam%2Fpromo.svg)](https://www.npmjs.com/package/@epam%2Fpromo)                   | Styled set of components in Promo style                                      |
+| [@epam/assets](https://github.com/epam/UUI/tree/main/epam-assets)            | [![npm version](https://badge.fury.io/js/@epam%2Fassets.svg)](https://www.npmjs.com/package/@epam%2Fassets)                 | contains icons set, build-in themes and their fonts                          |
+| [@epam/uui-test-utils](https://github.com/epam/UUI/tree/main/test-utils)     | [![npm version](https://badge.fury.io/js/@epam%2Fuui-test-utils.svg)](https://www.npmjs.com/package/@epam%2Fuui-test-utils) | A set of helpers which facilitate creation of unit tests for UUI components. |
+| [@epam/uui-editor](https://github.com/epam/UUI/tree/main/uui-editor)         | [![npm version](https://badge.fury.io/js/@epam%2Fuui-editor.svg)](https://www.npmjs.com/package/@epam%2Fuui-editor)         | [Slate.js](https://www.slatejs.org/)-based Rich Text Editor                  |
+| [@epam/uui-timeline](https://github.com/epam/UUI/tree/main/uui-timeline)     | [![npm version](https://badge.fury.io/js/@epam%2Fuui-timeline.svg)](https://www.npmjs.com/package/@epam%2Fuui-timeline)     | UUI Timeline provides facilities to build a Ghant-chart like interfaces.     |
 
 ## Contribution
 

draft-rte/readme.md

@@ -2,4 +2,4 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-@epam/draft-rte contains [Draft](https://draftjs.org/)-based Rich Text Editor. This package is on hold, as we switched to the Slate-based editor in @epam/editor.
+`@epam/draft-rte` contains [Draft](https://draftjs.org/)-based Rich Text Editor. This package is deprecated, as we switched to the Slate-based editor in @epam/editor.

epam-assets/readme.md

@@ -2,6 +2,6 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-@epam/assets contains variety of assets, which are usable without React:
+`@epam/assets` contains UUI assets, such as:
 - icons set
-- SCSS and LESS styles and mixins
+- themes and their fonts 

epam-electric/readme.md

@@ -2,4 +2,18 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-@epam/electric contains the 'Electric' 'skin'. All components branded with this skin are contained in this package.
+`@epam/electric` contains the 'Electric' skin components.
+
+### How to install
+
+```yarn add @epam/electric```
+
+### Add styles
+
+1. Add this to the root of your app:
+    ```
+    import '@epam/electric/styles.css';
+    import '@epam/assets/css/theme/theme_electric.css'
+    ```
+
+2. Add theme class `uui-theme-electric` to the html body tag.

epam-promo/readme.md

@@ -2,4 +2,17 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-@epam/promo contains the 'UUI4' (codename 'Promo') 'skin'. All components branded with this skin are contained in this package.
+`@epam/promo` contains the 'Promo' skin components.
+
+### Install
+
+```yarn add @epam/promo```
+
+### Add styles
+
+1. Add this to the root of your app:
+    ```
+    import '@epam/promo/styles.css';
+    ```
+
+2. Add theme class `uui-theme-promo` to the html body tag.

loveship/readme.md

@@ -2,4 +2,17 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-@epam/loveship contains the 'UUI3' (codename 'Loveship') 'skin'. All components branded with this skin are contained in this package.
+`@epam/loveship` contains the 'Loveship' skin components.
+
+### Install
+
+```yarn add @epam/loveship```
+
+### Add styles
+
+1. Add this to the root of your app:
+    ```
+    import '@epam/loveship/styles.css';
+    ```
+
+2. Add theme class `uui-theme-loveship` to the html body tag.

test-utils/readme.md

@@ -2,4 +2,6 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-It provides a set of helpers which facilitate creation of unit tests for UUI components.
+`@epam/uui-test-utils` provides a set of helpers which facilitate creation of unit tests for UUI components.
+
+The documentation about UUI testing approaches can be found [here](https://uui.epam.com/documents?id=testing-getting-started&mode=doc&isSkin=null&category=testing).

uui-build/readme.md

@@ -2,4 +2,5 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-@epam/uui-build is used internally to build UUI mono-repo. It contains scripts to run the repo as a single huge app (for development needs), and build each package separately for NPM.
+`@epam/uui-build` consist scripts and tools to build UUI mono-repo. It contains scripts to run the repo as a single huge app (for development needs), and build each package separately for NPM.
+Also, its contains some external scripts which can be used we UUI ecosystem.

uui-components/readme.md

@@ -2,26 +2,7 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-@epam/uui-components is a set base components to build brand-looking components library on top. All components are not styled, and contains CSS marker classes to apply any styling to them, without the need to override any base styles.
+`@epam/uui-components` is a set base components to build brand-looking components library on top. 
 
-## Features
-
-- complete components set:
-  -  buttons, links
-  -  drag-n-drop primitives
-  -  inputs
-     -  basic: text, textarea, checkbox, radio group, switch, etc.
-     -  date and time pickers
-  -  layout - flexbox helpers, control groups, virtual list, accordion
-  -  navigation, including adoptive main menu (top-bar) navigation solution
-  -  overlays: tooltips, modals, snackbar
-  - Pickers: components to choose one or many from the list
-    - dropdown, modal, checkbox/radio-group
-    - supports lazy-loading, and hierarchies
-    - search, show selected, selection cascading
-  - Data Table
-    - rows rendering virtualization
-    - lazy loading, hierarchies (trees)
-    - mature feature set: sorting, filtering, fixed columns, column resizing and reordering
-    - editable cells
-- used to build 3 comprehensive skins on top
+All components here are not styled, and contains CSS marker classes to apply any styling to them, without the need to override any base styles. 
+If you are looking for already styled components please use `@epam/uui` package with theme or skins.

uui-core/readme.md

@@ -2,10 +2,11 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-@epam/uui-core contains a core parts of the UUI library
+`@epam/uui-core` contains a core parts of the UUI library
 
 It contains:
 - Typescript interfaces to allow different UUI packages inter-operate
-- Services to call API, handle errors, etc.
+- Services to call API, handle errors, manage modals and notification, etc.
 - State management primitives - Forms, validation, Data Sources
+- hooks - `useForm`, `useTableState`, `useVirtualList` and others
 - helper functions

uui-docs/readme.md

@@ -2,7 +2,7 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-@epam/uui-docs is a set of helpers to document UUI libraries.
+`@epam/uui-docs` is a set of helpers to document UUI libraries.
 
 ## Features
 

uui-e2e-tests/readme.md

@@ -1,5 +1,12 @@
-# Install container management tool
-## Windows
+# UUI e2e tests package
+
+This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
+
+This is internal package for e2e testing of UUI.
+
+
+## Install container management tool
+### Windows
 #### Option 1: Podman v5.x
 1. Install Podman v5.x from here: https://github.com/containers/podman/releases 
 You might need to restart computer after that.
@@ -32,7 +39,7 @@ You might need to restart computer after that.
     podman machine rm
     ```
 
-## macOS
+### macOS
 #### Option 1: Colima
 1. Install Colima via CLI:
     ```shell 
@@ -54,13 +61,13 @@ You might need to restart computer after that.
     ```
 2. Other steps are the same as for Windows (see above)
 
-## Usage of alternative tools not mentioned in this guide
+### Usage of alternative tools not mentioned in this guide
 By default, if "podman" is detected, then it is used to build/run containers; otherwise "docker" is used as fallback;
 To override the default behavior, you might explicitly specify any tool via ```.env``` file using ```UUI_DOCKER_CONTAINER_ENGINE=<cmd>``` option.
 Please make sure that this tool is compatible with Docker's CLI.
 
-# Run tests locally (via Docker)
-## Prerequisites
+## Run tests locally (via Docker)
+### Prerequisites
 1. Server is started. Possible options:
    * Local dev server **(this is default option)**
      * Pros: Convenient when you make changes to e2e tests and want to see results right away
@@ -89,7 +96,7 @@ yarn test-e2e-update
 yarn test-e2e-open-report
 ```
 
-# Run tests locally (without Docker)
+## Run tests locally (without Docker)
 > Important note. Our baseline screenshots are generated on Linux; and the generated screenshots differ for different OS/platform. This is why Docker has to be used on non-Linux computers to run the screenshots tests. 
 
 Cases when you can run tests without Docker:

uui-editor/readme.md

@@ -8,9 +8,8 @@ This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
 - modern floating panels UX, to allow in-line usage (seamless transitions from view to edit modes)
 - full set of basic markups: headers, bold, italic, etc.
-- embedding and positioning images
+- embedding and resizing images
 - full-featured tables plugin
 - video, files, and pdf embedding
-- placeholders to build email templates
-- additional markup, like quote blocks
-- extensible with custom components, thanks to Slate
+- additional markup, like quote and notes blocks
+- extensible with custom components

uui/readme.md

@@ -2,4 +2,9 @@
 
 This package is a part of [EPAM UUI](https://github.com/epam/UUI) library.
 
-@epam/uui contains the 'UUI' (codename 'UUI') 'skin'. All components branded with this skin are contained in this package.
+`@epam/uui` contains theme agnostic set of UUI components. 
+
+It's required to connect any theme to your application for components styling. 
+You can read more about UUI Themes [here](https://uui.epam.com/documents?id=overview-themes&mode=doc&isSkin=null&category=themes).
+
+Full set of components can be found on [UUI site](https://uui.epam.com/documents?category=components&id=accordion&mode=doc).