@mozaic-ds/angular 2.0.0-beta.0 → 2.0.0-beta.1

package/README.md

@@ -1,63 +1,123 @@
-# MozaicNg
+<p align="center">
+  <img alt="ADEO Design system - Angular library" src="./.storybook/assets/sidebar-logo.svg" />
+</p>
+
+<h1 align="center">
+  ADEO Design system - Angular
+</h1>
+
+<p align="center">
+  A library of <a href="https://angular.io">Angular</a> components implementing ADEO Design system guidelines.
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@mozaic-ds/angular">
+    <img src="https://img.shields.io/npm/v/@mozaic-ds/angular?label=NPM&logo=npm&color=yellow" alt="npm version">
+  </a>
+  <a href="https://adeo.github.io/mozaic-angular">
+    <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/CN4K3A99R">
+    <img src="https://img.shields.io/badge/Slack-mozaic_angular-611f69.svg?logo=slack" alt="Slack mozaic-angular" />
+  </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>
+
+## 🎨 Getting started
+
+**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/).
+
+## 📦 Install
+
+To install the Angular library in your project, you will need to run the following command using `npm`:
+
+```shell
+npm i @mozaic-ds/angular
+```
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.0.0.
+Or with **Yarn**:
 
-## Code scaffolding
+```shell
+yarn add @mozaic-ds/angular
+```
 
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
+## 📝 Usage
 
-```bash
-ng generate component component-name
-```
+Import the styles in styles.scss
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+```typescript
 
-```bash
-ng generate --help
+@use '@mozaic-ds/tokens/adeo/theme' as *;
+@use '@mozaic-ds/styles/tools/t.font' as *;
+@use '@mozaic-ds/tokens' as *;
 ```
 
-## Building
+To import and use a component, you can proceed as follows:
 
-To build the library, run:
+```vue
+<script setup lang="ts">
+import { MozButtonComponent } from '@mozaic-ds/angular';
+</script>
 
-```bash
-ng build mozaic-ng
+<template>
+  <button moz-button>This is a Mozaic Button</button>
+</template>
 ```
 
-This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
+Find the complete list of [our components](https://github.com/adeo/mozaic-angular/tree/feat/moz-v2/projects/mozaic-ng/src/lib).
+
+And all the available components are showcased in our [Storybook](https://adeo.github.io/mozaic-angular/).
+
+## 📰 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.
 
-### Publishing the Library
+## 📣 Stay in touch
 
-Once the project is built, you can publish your library by following these steps:
+- Join the [#mozaic-angular](https://adeo-tech-community.slack.com/archives/C01BB8911M4) channel on **Slack**
+- Join the [#mozaic-support](https://adeo-tech-community.slack.com/archives/CKQJZL7C4) channel on **Slack**
+- Follow our [KEYS page](https://keys.adeo.com/keys/ls/space/2583429798460717/adeo-adeo-design-system)
 
-1. Navigate to the `dist` directory:
-   ```bash
-   cd dist/mozaic-ng
-   ```
+## 🐞 Bugs and feature requests
 
-2. Run the `npm publish` command to publish your library to the npm registry:
-   ```bash
-   npm publish
-   ```
+Have a bug or a feature request?<br/>
+Please [open an issue](https://github.com/adeo/mozaic-angular/issues/new/choose) and use the template associated with your request.
 
-## Running unit tests
+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)_
 
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+## ✍️ Contributing
+
+Setup the project to start contributing.
 
-```bash
-ng test
 ```
+// Clone the repo
+$ git clone git@github.com:adeo/mozaic-angular.git
 
-## Running end-to-end tests
+// Go to the cloned directory
+$ cd mozaic-angular
 
-For end-to-end (e2e) testing, run:
+// Checkout the branch you are working on
+$ git checkout <branch name>
 
-```bash
-ng e2e
+// Install dependencies
+$ npm install
 ```
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
+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).
+
+## 🧑‍💻 Contributors
+
+**Owners**
+
+**[ADEO Design system Team](https://github.com/orgs/adeo/teams/adeo-design-system)**
+
+**Maintainer**
+
+- **[David Martin](https://github.com/dmartinds)**
 
-## Additional Resources
+## 📄 Licensing
 
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.