@amsom-habitat/ui 2.0.0 → 2.0.4

package/README.md

@@ -1,7 +1,41 @@
-# Vue 3 + Vite
+# AMSOM UI
 
-This template should help get you started developing with Vue 3 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.
+Ce package regroupe plusieurs composant déstiné à l'UI des outils d'AMSOM Habitat est est disponible [ici](https://www.chromatic.com/library?appId=65e972814b5f7a6462f17d16)
 
-## Recommended IDE Setup
+Il regroupe les packages :
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+- AmsomModal voir la documentation [ici](AmsomModal.md)
+- AmsomOverlay voir la documentation [ici](AmsomOverlay.md)
+- AmsomCard voir la documentation [ici](AmsomCard.md)
+
+## Installation
+
+```bash
+npm i @amsom-habitat/ui
+```
+
+## Développment
+
+Après avoir fait vos dev, veillez à bien tenir à jour le [changelog.md](changelog.md) ainsi que la version du package.json puis faites :
+```bash
+git add .
+git commit -m '<commentaire'
+git push origin <branch>
+```
+
+## Tests
+
+Les tests sont réalisé de manière automatique sur les branches main et dev mais peuvent être fait localement, notemment pour voir l'evolution du développement via la commande :
+```bash
+npm run storybook
+```
+
+Le valideur devra, si des changements sont observés, aller sur la pipeline pour valider les différences à l'aide de chromatic, sans cela aucun merge-request ne sera possible. Si un merge est effectué, une double verification sera necessaire.
+
+## Déploiement
+
+Après avoir merge les dev sur la branche main, exécutez :
+```bash
+make publish
+```
+Cette commande vérifie la version, le changelog et publie le tout