@mozaic-ds/icons 2.0.0-beta.48 → 2.0.0-beta.49

package/README.md

@@ -1,34 +1,37 @@
+<p align="center">
+  <img alt="ADEO Design system - Icons" src="assets/images/adeo-design-system-icons-banner.svg" />
+</p>
+
 <h1 align="center">
-  Mozaic-Icons
+  ADEO Design system - Icons
 </h1>
 
 <p align="center">
-  <a href="https://mozaic.adeo.cloud/">
-    <img src="assets/images/adeo-design-system.svg"/>
-  </a>
-  <a href="https://developer.mozilla.org/en-US/docs/Web/SVG">
-    <img src="assets/images/made-with-svg.svg"/>
-  </a>
+  A library containing all of the icons of the ADEO Design system<br/>
+  and generating icons as components for libraries.
 </p>
 
 <p align="center">
+  <a href="https://www.npmjs.com/package/@mozaic-ds/icons/v/beta">
+    <img src="https://img.shields.io/npm/v/@mozaic-ds/icons/beta?label=NPM&logo=npm&color=yellow" alt="npm alpha version">
+  </a>
   <a href="/CONTRIBUTING.md">
     <img src="https://img.shields.io/badge/PRs-welcome-blue.svg?logo=github" alt="PRs welcome" />
   </a>
-  <a href="https://mozaic.adeo.cloud/foundations/icons/catalog/">
-    <img src="https://img.shields.io/badge/Icons-364-orange.svg?style=" alt="number of icons" />
-  </a>
-  <a href="https://app.slack.com/client/T4R6RCZFA/CKQJZL7C4/">
-    <img src="https://img.shields.io/badge/Slack-mozaic_support-611f69.svg?logo=slack" alt="Slack mozaic support" />
+  <a href="https://app.slack.com/client/T4R6RCZFA/CKQJZL7C4">
+    <img src="https://img.shields.io/badge/Slack-mozaic_support-611f69.svg?logo=slack" alt="Slack mozaic-support" />
   </a>
-  <a href="https://adeo.workplace.com/groups/427492661454646/">
-    <img src="https://img.shields.io/badge/Workplace-Adeo_Design_System-4526ce.svg?logo=workplace" alt="Workplace ADEO Design system" />
+  <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>
 
-<p align="center">
-  This project contains all of the icons of the <a href="https://mozaic.adeo.cloud/">ADEO Design system</a>.
-</p>
+<h2 align="center">
+  Related:
+  <a href="https://github.com/adeo/mozaic-icons-vue">Vue Icons</a>
+  <span> · </span>
+  <a href="https://github.com/adeo/mozaic-icons-svelte">Svelte Icons</a>
+</h2>
 
 ## 🎨 Getting started
 
@@ -38,11 +41,21 @@ Learn more about the vision and guidelines by visiting the [main documentation w
 
 ## 📦 Install
 
+To install the library in your project, you will need to run the following command using `npm`:
 
+```shell
+$ npm i @mozaic-ds/icons@beta
+```
 
-## 📝 Usage
+Or with **Yarn**:
 
+```shell
+$ yarn add @mozaic-ds/icons@beta
+```
+
+## 📝 Usage
 
+Import the SVG of the icon needed from the `build/svg` folder.
 
 ## 📰 Changelog
 
@@ -52,7 +65,7 @@ Access to the [Changelog](/CHANGELOG.md) to find out about the detailed changes
 ## 📣 Stay in touch
 
 - Join the [#mozaic-support](https://app.slack.com/client/T4R6RCZFA/CKQJZL7C4/) channel on **Slack**
-- Join our [Workplace group](https://adeo.workplace.com/groups/427492661454646/)
+- Follow our [KEYS page](https://keys.adeo.com/keys/ls/space/2583429798460717/adeo-adeo-design-system)
 
 ## 🐞 Bugs and feature requests
 
@@ -66,7 +79,7 @@ However, if you are able to contribute and fix bugs, build new features, or help
 Setup the project to start contributing.
 
 ```
-// Clone mozaic-vue repo
+// Clone the repo
 $ git clone git@github.com:adeo/mozaic-icons.git
 
 // Go to the cloned directory