From c8d9473e6dd18c2c2733ae99a470432b76ece615 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20DA=20ROCHA?= <sebastien@da-rocha.net>
Date: Tue, 6 Feb 2024 15:19:52 +0100
Subject: [PATCH] Javascript documentation

---
 README.md | 31 +++++++++++++++++++++++++++----
 1 file changed, 27 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 932de8c..f614f68 100644
--- a/README.md
+++ b/README.md
@@ -18,9 +18,9 @@ The jobs are called on the `check_docker` stage. You can change this when extend
 
 ### Python
 
-This job uses pylic to check that all the python modules in the current venv are compatible with Affero GPL3 License
+This job uses `pylic` to check that all the python modules in the current venv are compatible with Affero GPL3 License
 
-You should call the job on a docker image that inherits from python. The entryp point of your imag should allow the execution of a command, override it if it is not the case.
+You should call the job on a docker image that inherits from python. The entryppoint of your image should allow the execution of a command, override it if it is not the case.
 
 *You need to have `curl` installed.*
 
@@ -30,6 +30,7 @@ Include the correct template in your .gitlab-ci.yml :
 include:
   - project: neogeo/license-conformity
     file: /templates/check_license.yaml
+    ref: main
 ```
 
 Then you can invoke a job that extents `.check_license_conformity_python_docker` job template :
@@ -43,11 +44,33 @@ check_licence_conformity:
             - ''
 ```
 
+### Javascript
+
+This job uses `license-checker` to check the dependencies conformities to AGPL3 (the ones declared on th package.json).
+
+This job uses a standart nodejs docker image to check the dependencies.
+
+Include the correct template in your .gitlab-ci.yml :
+
+```
+include:
+  - project: neogeo/license-conformity
+    file: /templates/check_license.yaml
+    ref: main
+```
+
+Then you can invoke a job that extents `.check_license_conformity_javascript` job template :
+```
+check_licenses_nodejs:
+  extends: .check_license_conformity_javascript
+  stage: test-build
+```
+
 ## Support
 Request help on Neogeo slack #techs
 
 ## Roadmap
-- Handle Javascript dependencies licenses
+N/A
 
 ## Contributing
 Open to contributions:
@@ -61,4 +84,4 @@ Sébastien DA ROCHA @ Neogeo Technologies
 Affero GPL 3.0
 
 ## Project status
-In developpement
+Maintenance
-- 
GitLab