From 1de8954f0f8e7d744bedfccf56e8a4aa2fdcf701 Mon Sep 17 00:00:00 2001
From: LBF38 <contact.lbf38@gmail.com>
Date: Wed, 4 Jan 2023 02:31:28 +0100
Subject: [PATCH] Updated README and GH Actions

I modified the GitHub Actions
to verify the build and the javadoc before we can push on main.
---
 .github/workflows/maven.yml |  4 ++--
 README.md                   | 11 +++++++++++
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
index e8014c6..b0e9fec 100644
--- a/.github/workflows/maven.yml
+++ b/.github/workflows/maven.yml
@@ -6,7 +6,7 @@
 # separate terms of service, privacy policy, and support
 # documentation.
 
-name: Java CI with Maven
+name: Verify Maven build and javadoc for Java project
 
 on:
   push:
@@ -29,4 +29,4 @@ jobs:
         distribution: 'temurin'
         cache: maven
     - name: Build with Maven
-      run: mvn -B package --file duelinvaders/pom.xml
+      run: mvn clean javadoc:jar -B package --file duelinvaders/pom.xml
diff --git a/README.md b/README.md
index 7111f8c..15aa072 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,17 @@ mvn clean package
 > **Note**
 > Vous devez exécuter cette commande dans le dossier du projet contenant le fichier `pom.xml`. Ici, le dossier racine du projet est `duelinvaders`.
 
+Vous pouvez également compiler la javadoc du projet en exécutant la commande suivante :
+
+```bash
+mvn javadoc:javadoc
+```
+
+La javadoc sera générée dans le dossier `target/site/apidocs` du projet. (par défaut)
+
+> **Note**
+> Les releases fournissent la javadoc du projet en archive `.jar`. Ils sont builds avec la commande `mvn clean package javadoc:jar` et sont disponibles dans la section [Releases](https://github.com/LBF38/Duel-invaders/releases) du projet.
+
 ### Exécution
 
 > **Warning**