@mozaic-ds/chart 0.1.0-beta.37 → 0.1.0-beta.39

package/README.md

@@ -1,16 +1,92 @@
-# Vue 3 + TypeScript + Vite
+<p align="center">
+  <img alt="ADEO Design system - Chart library" src="./.storybook/assets/adeo-design-system-chart-banner.svg" />
+</p>
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+<h1 align="center">
+  ADEO Design system - Chart (community)
+</h1>
 
-## Recommended IDE Setup
+<p align="center">
+  A library of <a href="https://vuejs.org">Vue.js</a> components on top of Chartjs implementing ADEO Design system guidelines.
+</p>
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
+<p align="center">
+  <a href="https://www.npmjs.com/package/@mozaic-ds/chart/v/beta">
+    <img src="https://img.shields.io/npm/v/@mozaic-ds/chart/beta?label=NPM&logo=npm&color=yellow" alt="npm version">
+  </a>
+  <a href="https://github.com/adeo/mozaic-chart/blob/main/CONTRIBUTING.md">
+    <img src="https://img.shields.io/badge/PRs-welcome-blue.svg?logo=github" alt="PRs welcome" />
+  </a>
+  <a href="https://app.slack.com/client/T4R6RCZFA/C04DE3DN8LD">
+    <img src="https://img.shields.io/badge/Slack-mozaic_chart-611f69.svg?logo=slack" alt="Slack mozaic-chart" />
+  </a>
+  <a href="https://keys.adeo.com/keys/ls/space/2583429798460717/adeo-adeo-design-system">
+    <img src="https://img.shields.io/badge/KEYS-Adeo_Design_System-4526ce.svg" alt="KEYS ADEO Design system" />
+  </a>
+</p>
 
-## Type Support For `.vue` Imports in TS
+## 🎨 Getting started
 
-Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
+**ADEO Design system** is a global and collaborative design system that facilitates the designer and developer experience, enabling them to create universal interfaces perfectly aligned with the business strategy of [Adeo](https://www.adeo.com/).
 
-1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
-2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
+## 📦 Install
 
-You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).
+To install the Chart library in your project, you will need to run the following command using `npm`:
+
+```shell
+npm i @mozaic-ds/chart
+```
+
+Or with **Yarn**:
+
+```shell
+yarn add @mozaic-ds/chart
+```
+
+## 📝 Usage
+
+Find the complete list of [our components](https://github.com/adeo/mozaic-chart/tree/next/src/components).
+
+And all the available components are showcased in our [Storybook](http://adeo.github.io/mozaic-chart).
+
+## 📰 Changelog
+
+Releases are managed with **GitHub Releases**, including the changelog for each one.<br/>
+Access to the [Changelog](/CHANGELOG.md) to find out about the detailed changes to each release.
+
+## 📣 Stay in touch
+
+- Join the [#mozaic-chart](https://app.slack.com/client/T4R6RCZFA/CN4K3A99R/) channel on **Slack**
+- Join the [#mozaic-support](https://app.slack.com/client/T4R6RCZFA/CKQJZL7C4/) channel on **Slack**
+- Follow our [KEYS page](https://keys.adeo.com/keys/ls/space/2583429798460717/adeo-adeo-design-system)
+
+## 🐞 Bugs and feature requests
+
+Have a bug or a feature request?<br/>
+Please [open an issue](https://github.com/adeo/mozaic-chart/issues/new/choose) and use the template associated with your request.
+
+However, if you are able to contribute and fix bugs, build new features, or help to improve the project documentation, feel free to do it! _(more information below)_
+
+## ✍️ Contributing
+
+Setup the project to start contributing.
+
+```
+// Clone the repo
+$ git clone git@github.com:adeo/mozaic-chart.git
+
+// Go to the cloned directory
+$ cd mozaic-chart
+
+// Checkout the branch you are working on
+$ git checkout <branch name>
+
+// Install dependencies
+$ npm install
+```
+
+We're always looking for contributors to help us fix bugs, build features, or help us improve the documentation. If you're intersted check out our [Code of Conduct](CODE_OF_CONDUCT.md) and [Contribution Guide](CONTRIBUTING.md).
+
+## 📄 Licensing
+
+This project is licensed under the MIT License. See [LICENSE](LICENSE) for more information.