Add documentation #12

Signed-off-by: tdruez <[email protected]>

Author: tdruez

.github/workflows/scan-codebase.yml

@@ -9,7 +9,7 @@ jobs:
         with:
           path: scancode-inputs
       - name: Run scancode-action from current branch
-        uses: ./scancode-inputs/action.yml
+        uses: ./scancode-inputs
         with:
           pipelines: "scan_codebase"
           check-compliance: true

README.md

@@ -21,6 +21,7 @@ Workflows.
   - [Choose the output formats](#choose-the-output-formats)
   - [Provide download URLs inputs](#provide-download-urls-inputs)
   - [Fetch pipelines inputs](#fetch-pipelines-inputs)
+  - [Check for compliance issues](#check-for-compliance-issues)
   - [Define a custom project name](#define-a-custom-project-name)
   - [Install ScanCode.io from a repository branch](#install-scancodeio-from-a-repository-branch)
 - [Where does the scan results go?](#where-does-the-scan-results-go)
@@ -89,8 +90,6 @@ Workflows examples.
 
 ### Scan repo codebase
 
-TODO: Why, file only!
-
 ```yaml
 steps:
 - uses: actions/checkout@v4
@@ -163,6 +162,20 @@ For details on setting up and configuring your own instance, please refer to the
     pipelines: "scan_single_package"
 ```
 
+### Check for compliance issues
+
+```yaml
+- uses: nexB/scancode-action@alpha
+  with:
+    check-compliance: true
+    compliance-fail-level: "WARNING"
+```
+
+> [!NOTE]
+> This feature requires to provide Project policies. 
+> For details on setting up and configuring your own instance, please refer to the 
+> [ScanCode.io Policies documentation](https://scancodeio.readthedocs.io/en/latest/policies.html).
+
 ### Define a custom project name
 
 ```yaml