@carto/meridian-ds 0.1.0

package/CHANGELOG.md

@@ -0,0 +1 @@
+# CHANGELOG

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, 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

@@ -0,0 +1,38 @@
+# CARTO Design System
+
+<p>
+  <a href="https://npmjs.org/package/@carto/meridian-ds">
+    <img src="https://img.shields.io/npm/v/@carto/meridian-ds.svg?style=flat-square" alt="version" />
+  </a>
+</p>
+<br/>
+
+This is the official "CARTO Meridian Design system" for React built with Material-UI. This library provides a set of components and styles to build applications with the CARTO look and feel with a CARTO theme and Material-UI components wrapped with CARTO styles.
+
+To work in the code, see [developers](DEVELOPERS.md).
+
+There is a Storybook guide with the main UI components and how to use them at [CARTO for React - UI Components](https://storybook-react.carto.com/)
+
+## Installation
+
+This package is published in the npm registry as `@carto/meridian-ds`.
+
+### Yarn
+
+```bash
+yarn add @carto/meridian-ds
+```
+
+### NPM
+
+```bash
+npm install @carto/meridian-ds
+```
+
+### PNPM
+
+```bash
+pnpm add @carto/meridian-ds
+```
+
+Notice that to avoid issues within host projects, most of the base libraries are declared as **peer dependencies** (echarts, material-ui..). That means that you would need to add them explicitly to your project, if you are still not using them (keep an eye on the console warnings on peer dependencies).