docs: update readme (#5)

* docs: update readme

* docs: simplify readme intro

* docs: fix typo

Co-authored-by: Randh1r Gulraj <randhir.gulraj@the-future-group.com>

---------

Co-authored-by: Randh1r Gulraj <randhir.gulraj@the-future-group.com>

Author: ppvg

README.md

@@ -1,60 +1,46 @@
 # SonarQube Scanner GitHub Action
 
 This repository provides a reusable GitHub Action for running SonarQube scans in GitHub Workflows.
-It is designed to standardize the logic around the original [SonarQube Scanner Action](https://github.com/SonarSource/sonarqube-scan-action),
-automatically handling details such as providing the correct branch name for pull requests and checking if the pull request is a fork.
-
-## Features
-
-- Standardizes the [SonarQube Scanner Action](https://github.com/SonarSource/sonarqube-scan-action) for consistent usage across projects
-- Ability to configure the project base directory for SonarQube analysis
-- Provide branch name to the scan action when running on pull requests
-- Prevents the scan action from running on pull requests from forks by default
+It wraps the official [SonarQube Scanner Action](https://github.com/SonarSource/sonarqube-scan-action) to standardize details such as providing the correct branch name for pull requests and checking if the pull request is made from a fork.
 
 ## Usage
 
-Here is a basic example of how you can integrate it in your project.
-
-<details>
-  <summary>Example workflow</summary>
-
-This workflow is executed automatically on push to the main branch, on a pull request and can also be executed manually from the actions tab `workflow_dispatch`.
-
-In the code below you need to replace `${{ secrets.SONAR_TOKEN }}` with the secret that contains the SonarQube token you want to use.
+To use the action, add it to a workflow in your repository:
 
 ```yml
 name: Run SonarCloud scanner
 
 on:
-  workflow_dispatch:
-  pull_request:
-  push:
-    branches:
-      - main
+    workflow_dispatch:
+    pull_request:
+    push:
+        branches:
+            - main
 
 jobs:
     sonarcloud-scanner:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      # Using the action
-      - name: Install dependencies
-        uses: minvws/action-sonarcube-cloud@v1
-        with:
-            sonar-token: ${{ secrets.SONAR_TOKEN }}
+        - name: Checkout repository
+          uses: actions/checkout@v4
+
+        - name: Run SonarQube scan
+          uses: minvws/action-sonarcube-cloud@v1
+          with:
+              sonar-token: ${{ secrets.SONAR_TOKEN }}
 ```
 
-</details>
+Make sure to add the `SONAR_TOKEN` secret to your repository's configuration. See [Using secrets in GitHub Actions](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets).
+
+In this basic example, the workflow is executed automatically on push to the `main` branch and on any pull request. And thanks to the `workflow_dispatch` trigger it can also be executed manually from the repository's Actions tab.
 
 ### Configuration
 
-The action has inputs. The inputs are:
+The action has the following inputs:
 
-- sonar-token: the SonarQube token
-- project-base-dir: set the sonar.projectBaseDir analysis property, default is `.`
-- allow-run-on-fork: allow SonarQube scan to run on pull requests from forks (default: false)
+- `sonar-token`: the SonarQube token.
+- `project-base-dir`: set the sonar.projectBaseDir analysis property, default is `.`.
+- `allow-run-on-fork`: allow SonarQube scan to run on pull requests from forks (default: false).
 
 ## Contribution
 
@@ -65,7 +51,7 @@ Git commits must be signed. Please check the [Signing commits documentation on G
 
 ## License
 
-This repository is released under the EUPL 1.2 license. [See LICENSE](LICENSE.txt) for details.
+This repository is released under the EUPL 1.2 license. [See LICENSE.txt](./LICENSE.txt) for details.
 
 ## Part of iCore