Merge pull request #43 from opt-nc/develop

Develop

.github/workflows/release-publish.yml

@@ -36,9 +36,18 @@ jobs:
       
       - name: 🐳 Docker build and push
         if: github.ref == 'refs/heads/develop' || steps.release.outputs.new_release_published == 'true'
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v4
         with:
           context: .
           push: true
           tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: ✏️ Update Docker Hub Description
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.OPT_DOCKERHUB_LOGIN }}
+          password: ${{ secrets.OPT_DOCKERHUB_PASSWORD }}
+          repository: optnc/generative-art-temps-attente
+          short-description: ${{ github.event.repository.description }}
+          readme-filepath: DOCKERHUB.md

DOCKERHUB.md

@@ -0,0 +1,43 @@
+[![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)
+[![Test, Release](https://github.com/opt-nc/generative-art-temps-attente/actions/workflows/release-publish.yml/badge.svg)](https://github.com/opt-nc/generative-art-temps-attente/actions/workflows/test-release.yml)
+[![Docker Image](https://img.shields.io/badge/docker-homepage-blue)](https://hub.docker.com/r/optnc/generative-art-temps-attente)
+![Docker Pulls](https://img.shields.io/docker/pulls/optnc/generative-art-temps-attente)
+![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/optnc/generative-art-temps-attente/latest)
+![Docker Stars](https://img.shields.io/docker/stars/optnc/generative-art-temps-attente)
+![Docker Image Version (latest by date)](https://img.shields.io/docker/v/optnc/generative-art-temps-attente/latest)
+
+# Art Génératif (p5.js)
+
+## 💬 Temps d'attente dans les différentes agences de l'OPT NC
+
+Projet de stage étudiant autour de la visualisation des données recueillies par les différentes agences de l'OPT NC.
+
+La visualisation est réalisée grâce à la librairie Javascript p5.js <br>
+<https://p5js.org/>
+
+Ce projet utilise l'API REST des temps d'attente en agence OPT.nc <br>
+<https://github.com/adriens/opt-temps-attente-agences-api>
+
+## 🚀 Lancer les visualisations
+
+### 🐳 Par Docker
+```
+docker run --name opt-temps-attente-agences-viz -d -p 80:80 optnc/generative-art-temps-attente
+docker run --name opt-temps-attente-agences-api -d -p 8081:8081 optnc/opt-temps-attente-agences-api
+docker ps
+```
+
+### ⚙️ Ou localement
+```sh
+git clone https://github.com/opt-nc/generative-art-temps-attente.git
+cd generative-art-temps-attente
+docker-compose up -d
+docker-compose ps
+```
+
+## 🎇 Pour accéder aux visualisations
+
+* <http://127.0.0.1/> (Projet par défaut : Orbit)
+* <http://127.0.0.1/orbit.min.html> (Version allégée de métriques)
+* <http://127.0.0.1/jumpers.html>
+* <http://127.0.0.1/gravity.html>

README.md

@@ -10,22 +10,15 @@
 
 ## :speech_balloon: Temps d'attente dans les différentes agences de l'OPT NC
 
-Projet de stage étudiant autour de la visualisation des données recueillies par les différentes agences de l'OPT NC.
+Projet autour de la visualisation des données recueillies par les différentes agences de l'OPT NC.
 
-La visualisation est réalisée grâce à la librairie Javascript p5.js <br>
-<https://p5js.org/>
+👉 Tous les détails sur ce [post dédié](https://dev.to/optnc/from-waiting-time-metrics-to-generative-art-2d6d).
 
-Ce projet utilise l'API REST des temps d'attente en agence OPT.nc <br>
-<https://github.com/adriens/opt-temps-attente-agences-api>
+La visualisation est réalisée grâce à la librairie Javascript [`p5.js`](https://p5js.org/).
 
-## :rocket: Lancer les visualisations
+Ce projet utilise l'[API REST des temps d'attente en agence OPT.nc](https://github.com/opt-nc/opt-temps-attente-agences-api).
 
-### :whale: Par Docker
-```
-docker run --name opt-temps-attente-agences-viz -d -p 80:80 optnc/generative-art-temps-attente
-docker run --name opt-temps-attente-agences-api -d -p 8081:8081 optnc/opt-temps-attente-agences-api
-docker ps
-```
+## :rocket: Lancer les visualisations
 
 ### :gear: Ou localement
 ```sh
@@ -37,7 +30,11 @@ docker-compose ps
 
 ## :fireworks: Pour accéder aux visualisations
 
-* <http://127.0.0.1/> (Projet par défaut : Orbit)
-* <http://127.0.0.1/orbit.min.html> (Version allégée de métriques)
-* <http://127.0.0.1/jumpers.html>
-* <http://127.0.0.1/gravity.html>
+- <http://127.0.0.1/> (Projet par défaut : Orbit)
+- <http://127.0.0.1/orbit.min.html> (Version allégée de métriques)
+- <http://127.0.0.1/jumpers.html>
+- <http://127.0.0.1/gravity.html>
+
+# 🔖 Ressources
+
+- [Article dédié sur DEV.to](https://dev.to/optnc/from-waiting-time-metrics-to-generative-art-2d6d)