@amsom-habitat/amsom-table 1.0.0

package/README.md

@@ -0,0 +1,44 @@
+# AMSOM UI
+
+Ce package regroupe les composants tableaux d'AMSOM Habitat
+
+Il regroupe les packages :
+
+- AmsomTableDraggable voir la documentation [ici](AmsomTableDraggable.md)
+
+## Installation
+
+```bash
+npm i @amsom-habitat/amsom-table
+```
+Importer les css dans le main.js tel que :
+```javascript
+import '@amsom-habitat/amsom-table/dist/style.css'
+```
+
+
+## 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