@carto/ps-react-ui 3.0.0 → 4.0.0-canary.0

package/LICENSE.md

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, CARTO
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,21 +1,24 @@
-# CARTO PS React Library - React UI
+# The CARTO PS React UI Library
 
-This repository contains the packages with react hooks helpers.
+<a aria-label="NPM version" href="https://www.npmjs.com/package/@carto/ps-react-ui">
+  <img alt="" src="https://img.shields.io/npm/v/@carto/ps-react-ui.svg?style=flat-square&labelColor=000000">
+</a>
+<a aria-label="License" href="https://github.com/CartoDB/carto-ps-lib/blob/canary/LICENSE.md">
+  <img alt="" src="https://img.shields.io/npm/l/@carto/ps-react-ui.svg?style=flat-square&labelColor=000000">
+</a>
+<a aria-label="CI status" href="https://github.com/carto/ps-react-material/actions/workflows/pull-request.yml?query=event%3Apush+branch%3Amain">
+  <img alt="" src="https://img.shields.io/github/actions/workflow/status/carto/ps-react-material/pull-request.yml?event=push&branch=main&style=flat-square&labelColor=000000">
+</a>
 
-## Installation
+## Introduction
 
-Install @carto/ps-react-ui like dependence:
+This package includes utility functions for JavaScript and TypeScript.
 
-```bash
-  npm install --save @carto/ps-react-ui
-```
+The following react material are available:
 
-## Usage
-
-The see what helpers are available, the interfaces and examples, see [docs](https://github.com/CartoDB/carto-ps-lib/blob/main/docs/modules/carto_ps_react_ui.md) section.
+_To_develop_
 
 ## Contributing
 
-See [the contributing guide](https://github.com/CartoDB/carto-ps-lib/blob/main/CONTRIBUTING.md) for detailed instructions on how to get started with our project.
-
-If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](https://github.com/CartoDB/carto-ps-lib/blob/main/CONTRIBUTING.md) for detailed instructions.
+Please read our [contributing](https://github.com/carto/carto-ps-lib/blob/main/CONTRIBUTING.md)
+guide before creating a pull request.