Merge remote-tracking branch 'origin/main' into main

Author: rubenvdlinde

README.md

@@ -1,5 +1,5 @@
 # Publiccode Action
-This GitHub Action automatically generates and updates a publiccode.yaml file in the root of your repository, based on repository metadata. The file is updated each time a push is made to the main branch. It is basically a more advanced varsion of [the publiccode softwareversion check](https://github.com/italia/publiccode-softwareversion-check-action/tree/master)
+This GitHub Action automatically generates and updates a `publiccode.yaml` file in the root of your repository, based on repository metadata. The file is updated each time a push is made to the main branch. It is basically a more advanced varsion of [the publiccode softwareversion check](https://github.com/italia/publiccode-softwareversion-check-action/tree/master)
 
 The Action works by running a Python script that reads repository metadata such as the repository name and description, and uses this information to create or update the publiccode.yaml file.
 
@@ -22,7 +22,7 @@ jobs:
         uses: OpenCatalogi/publiccode-action@latest
 ````
 
-In the above example a publiccode file is updated every time code on the `main` branche is touched
+In the above example a `publiccode` file is updated every time code on the `main` branche is touched
 
 ## Inputs
 
@@ -37,7 +37,7 @@ In the above example a publiccode file is updated every time code on the `main`
 
 
 ## Outputs
-The following outputs are provided by the action and can be used by other aciotns 
+The following outputs are provided by the action and can be used by other actions. 
 
 | Output Name    | Description                                     |
 |----------------|-------------------------------------------------|
@@ -58,13 +58,13 @@ steps:
       gitname: "Open Catalogi bot"
       gitmail: "bot@opencatalogi.nl"
 ````
-Note: Replace your-github-username with your actual GitHub username, and publiccode-update-action with the name of the repository where this action is hosted.
+Note: Replace `your-github-username` with your actual GitHub username, and `publiccode-update-action` with the name of the repository where this action is hosted.
 
 ## Architecture
-### Why python?
-Python is nativly supported by github actions underlaying containers and therefore very quick
+### Why Python?
+Python is natively supported by GitHub actions' underlaying containers and therefore very quick
 
 ### Asumptions
-We follow the "get data from the source" principle, in practice for this action that means that we se the repository as the source. So any settings in the repository (e.g. name and description) will overwrite the values already pressent in your publiccode.
+We follow the "get data from the source" principle, in practice for this action that means that we set the repository as the source. So any settings in the repository (e.g. name and description) will overwrite the values already pressent in your publiccode.
 
 Please note that this action does not handle errors or exceptions while reading metadata or writing to publiccode.yaml. You should ensure that your repository is properly set up to avoid any issues. For example, make sure that your repository name and description are not empty.