## ๐จ 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/).
Learn more about the vision and guidelines by visiting the [main documentation website](https://mozaic.adeo.cloud/).
## ๐ฆ Install
You must first install the [npm package](https://www.npmjs.com/package/@mozaic-ds/icons-vue):
```bash
npm install @mozaic-ds/icons-vue
```
Or with **Yarn**:
```bash
yarn add @mozaic-ds/icons-vue
```
## ๐ Usage
After the installation, you can start importing the icon component needed:
```vue
// In one of the .vue file of your application
```
## ๐ฐ Changelog
Releases are managed with **GitHub Releases**, including the changelog for each one.
Access to the [Changelog](/CHANGELOG.md) to find out about the detailed changes to each release.
## ๐ฃ Stay in touch
- 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?
Please [open an issue](https://github.com/adeo/mozaic-icons-vue/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.
```bash
// Clone the repo
git clone git@github.com:adeo/mozaic-icons-vue.git
// Go to the cloned directory
cd mozaic-icons-vue
// Checkout the branch you are working on
$ git checkout
// Install dependencies
npm install
// Build icons
npm run icons:build
// Build project
npm run build
```
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)**
**Maintainers**
- **[David Martin](https://github.com/dmartinds)**
## ๐ Licensing
This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.
