@agregio-solutions/design-system 1.12.1

package/README.md

@@ -0,0 +1,21 @@
+# Agregio Design System (Storybook and package generation)
+
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+
+⚠️ Warning: this file is probably the most important in this project. Please read it **carefully** before committing anything. Thanks! 🙏
+
+## Contributing
+
+This documentation only concerns devs that want to **contribute** to the project.
+
+If you are looking for documentation on **using** our component library, please refers to the [Zeroheight documentation](https://zeroheight.com/4943b159f/p/5667cb-introduction) instead.
+
+## Summary
+
+- [Styling components](./docs/styles.md): everything you need to know about styling components.
+- [Updating dependencies](./docs/updating-deps.md): if you need to update the front-end dependencies.
+- [Available scripts](./docs/available-scripts.md): if you have installed the front-end and want to know about the available npm scripts.
+- [Git flow & deployment process](./docs/deployment.md): if you need to deploy a new release of the front-end or understand how our CI/CD works.
+- [Commit message convention](./docs/commit-message.md): if you want to write consistent and magic commit messages 🪄
+- [Code Quality](./docs/code-quality.md): if you want to hear about the tools and practices chosen to ensure a good Code Quality.
+- [Managing Icons](./docs/icons-library.md): if you want to add, update or delete an icon from the Icon component.