@cxbox-ui/core 1.34.1 → 1.34.2

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2019 qnt
+   Copyright 2022 OOO "SI IKS LAB"
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,22 +1,69 @@
-
-# Cxbox UI · [![Build status](https://github.com/CX-Box/cxbox-ui/workflows/Build/badge.svg)](https://github.com/CX-Box/cxbox-ui/actions?query=workflow%3ABuild) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=CX-Box_cxbox-ui&metric=alert_status)](https://sonarcloud.io/dashboard?id=CX-Box_cxbox-ui) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=CX-Box_cxbox-ui&metric=coverage)](https://sonarcloud.io/dashboard?id=CX-Box_cxbox-ui)
-
-
-Cxbox UI is an open source library that supplies user interaction support for Cxbox framework in form of React components, Redux reducers and redux-observable epics for handling asynchronous actions.
-More specifically that includes:
-- Major UI abstractions of Cxbox framework such as Screen, View, Widget, Field
-- Standard actions, reducers and epics for handling Cxbox API, routing and build-in controls
-- Custom <Provider> component and `connect` function to work with combined Redux store of Cxbox UI library and your own application
-- Reusable UI controls
-
-# Main concepts
+<h2 align="center">CXBOX UI</h2>
+
+<div align="center">
+<a href="https://github.com/CX-Box/cxbox-ui/actions/workflows/build.yml"><img src="https://github.com/CX-Box/cxbox-ui/actions/workflows/build.yml/badge.svg" title="">
+</a> 
+<a href="https://sonarcloud.io/summary/overall?id=CX-Box_cxbox-ui"><img src="https://sonarcloud.io/api/project_badges/measure?project=CX-Box_cxbox-ui&metric=alert_status&branch=main" alt="sonar" title="">
+</a>
+</div>
+
+<blockquote>
+<div> 
+<p align="center">
+<h4 align="center">CXBOX - Rapid Enterprise Level Application Development Platform</h4>
+
+<p align="center">
+<a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat" alt="license" title=""></a>
+</p>
+
+<div align="center">
+  <h3>
+    <a href="https://cxbox.org/" target="_blank">
+      Website
+    </a>
+    <span> | </span>
+    <a href="http://demo.cxbox.org/" target="_blank">
+      Demo
+    </a>
+    <span> | </span>
+    <a href="https://doc.cxbox.org/" target="_blank">
+      Documentation
+    </a>
+  </h3>
+
+</div>
+
+
+
+<h3>Description</h2>
+<p>
+CXBOX main purpose is to speed up development of typical Enterprise Level Application based on Spring Boot. A fixed
+contract with a user interface called <a href="https://github.com/CX-Box/cxbox-ui" target="_blank">Cxbox-UI</a> allows backend developer to create
+typical interfaces providing just Json meta files. Full set of typical Enterprise Level UI components included -
+widgets, fields, layouts (views), navigation (screens).
+</p>
+</div>
+
+<h3>Using CXBOX</h2>
+<ul>
+<li> <a href="https://plugins.jetbrains.com/plugin/19523-tesler-helper" target="_blank">download Intellij Plugin</a> adds platform specific autocomplete, inspection, navigation and code generation features.
+</li>
+<li>
+ <a href="https://github.com/CX-Box/cxbox-demo" target="_blank">download Demo</a> and follow <a href="https://github.com/CX-Box/cxbox-demo#readme" target="_blank">README.md</a> instructions. Feel free to use demo as template project to start your own projects
+</li>
+</ul>
+</blockquote>
+
+# CXBOX UI
+
+## Main concepts
 
 UI side of Cxbox framework is based on a concept of configurable dashboards ("views") with widgets. Visually widgets could be  represented as a card with a table, graph, form or something more exotic inside.
 Internally, every widget has a direct link to an entity that we call "business component" (BC). BC controls what data is displayed on widget and whhich interactions are available to the user. Interactions could be a simple filtration or some complex business process, initiated through Cxbox API.
 Information about loaded views and widgets grouped into "screens" and stored in application Redux store.
 Client applications could reuse, extend and customize that functionality by providing its own reducers and epics, widgets and ui controls.
 
-# Installation
+## Installation
 
 Cxbox UI distributed in form of ES5 compatible npm package:
 ```sh
@@ -25,7 +72,7 @@ yarn add @cxbox-ui/core
 
 Several libraries are specified as peer dependencies and should be installed for client application: react, react-dom, redux, react-redux, rxjs, redux-observable, antd, axios. 
 
-# Usage
+## Usage
 
 <Provider> component provides configurable Redux context and should be used on top level of your application:
 
@@ -61,21 +108,6 @@ function mapStateToProps(store) {
 export default connect(mapStateToProps)(ClientComponent)
 ```
 
-# Documentation
-
-The documentation is divided into several sections:
-* [Tutorial](http://idocs.cxbox.io/ui/#/screen/tutorial)
-* [Components Overview](http://idocs.cxbox.io/ui/#/screen/components)
-* [Features](http://idocs.cxbox.io/ui/#/screen/features)
-* [API Reference](https://CX-Box.github.io/cxbox-ui)
-
-You could also check our [changelog section](https://github.com/CX-Box/cxbox-ui/blob/main/CHANGELOG.md).
-
-# Reporting an error
-
-In case you've encountered a problem, please open an issue with reproducible example and detailed description.  
-If you are also willing to provide a fix, please check our [contributing guide](https://github.com/CX-Box/cxbox-ui/blob/main/CONTRIBUTING.md)!
-
 # Contributing
 
 All contributions are welcomed, as even a minor pull request with grammar fixes or a single documentation update is of a significant help for us!