Update README.md

MathieuSoysal · Dec 25, 2021 · 677fdd7 · 677fdd7
1 parent cd61d16
commit 677fdd7
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -52,5 +52,12 @@ If your Java project is not in Java 17, don't forget to modify that line:
 
 Don't forget to configure your repository settings with your new GitHub Page. 😉
 
+### Badge
+
+```Markdown
+[![Javadoc](https://img.shields.io/badge/JavaDoc-Online-green)](https://YOUR-USERNAME.github.io/YOUR-REPO/javadoc/)
+```
+In the badge link, replace *YOUR-USERNAME* with your GitHub Username and replace *YOUR-REPO* with the name of your GitHub repository.
+
 ## License
 The Dockerfile and associated scripts and documentation in this project are released under the [Apache 2.0 License](https://github.com/MathieuSoysal/Javadoc-publisher.yml/blob/main/LICENSE).