Fix markdown linting errors and add vscode extension suggestion

.vscode/extensions.json

@@ -6,6 +6,7 @@
     "golang.go",
     "editorconfig.editorconfig",
     "esbenp.prettier-vscode",
-    "timonwong.shellcheck"
+    "timonwong.shellcheck",
+    "DavidAnson.vscode-markdownlint"
   ]
 }

README.md

@@ -1,13 +1,13 @@
 <div id="top"></div>
 
 <div align="center">
-  
+
 [![Contributors][contributors-shield]][contributors-url]
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
 [![Issues][issues-shield]][issues-url]
 [![MIT License][license-shield]][license-url]
-  
+
 </div>
 
 <br />
@@ -32,16 +32,16 @@
 
 This GitHub action implements the level 1 requirements of the [SLSA framework](https://slsa.dev/). By using this GitHub Action it is possible to easily generate the provenance file for different artifact types.
 Different artifact types include, but not limited to:
-* Files
-* Push event (Docker Hub, trigger different workflow, etc)
+
+- Files
+- Push event (Docker Hub, trigger different workflow, etc)
 
 While there are no integrity guarantees on the produced provenance at L1,
 publishing artifact provenance in a common format opens up opportunities for
 automated analysis and auditing. Additionally, moving build definitions into
 source control and onto well-supported, secure build systems represents a marked
 improvement from the ecosystem's current state.
 
-
 This is not an official GitHub Action set up and maintained by the SLSA team. This GitHub Action is built for research purposes by Philips Research. It is heavily inspired by the original [Provenance Action example](https://github.com/slsa-framework/github-actions-demo) built by SLSA.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
@@ -57,9 +57,9 @@ metadata format.
 
 ### Built With
 
-* [SLSA Framework](https://github.com/slsa-framework/slsa/)
-* [Golang](https://golang.org/)
-* [GitHub Actions](https://github.com/features/actions)
+- [SLSA Framework](https://github.com/slsa-framework/slsa/)
+- [Golang](https://golang.org/)
+- [GitHub Actions](https://github.com/features/actions)
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -70,34 +70,44 @@ Get started quickly by reading the information below.
 ### Prerequisites
 
 Ensure you have the following installed:
-* Golang
-* Docker
 
-#### Recommendations 
+- Golang
+- Docker
+
+#### Recommendations
 
 The following IDE is recommended when working on this codebase:
-* [VSCode](https://code.visualstudio.com/)
+
+- [VSCode](https://code.visualstudio.com/)
 
 ### Local Installation
 
 1. Clone the repo.
+
    ```sh
    git clone git@github.com:philips-labs/slsa-provenance-action.git
    ```
+
 1. Build the binary.
+
    ```sh
    make build
    ```
+
 1. Execute the binary.
+
    ```sh
    ./bin/slsa-provenance help
    ```
+
 ### Docker Image
-  
+
 Run the Docker Image by doing:
-   ```sh
-   docker run philipssoftware/slsa-provenance:latest
-   ```
+
+```sh
+docker run philipssoftware/slsa-provenance:latest
+```
+
 The docker image includes the working binary that can be executed by using the ``slsa-provenance`` command.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
@@ -107,6 +117,7 @@ The docker image includes the working binary that can be executed by using the `
 The easiest way to use this action is to add the following into your workflow file. Additional configuration might be necessary to fit your usecase.
 
 1. Add the following part in your workflow file:
+
    ```yaml
    generate-provenance:
     name: Generate build provenance
@@ -129,14 +140,15 @@ The easiest way to use this action is to add the following into your workflow fi
    ```
 
 <!-- action-docs-description -->
-#### Description
 
-An action to generate SLSA build provenance for an artifact
+### Description
 
+An action to generate SLSA build provenance for an artifact
 
 <!-- action-docs-description -->
 <!-- action-docs-inputs -->
-#### Inputs
+
+### Inputs
 
 | parameter | description | required | default |
 | - | - | - | - |
@@ -145,24 +157,22 @@ An action to generate SLSA build provenance for an artifact
 | github_context | internal (do not set): the "github" context object in json | `true` | ${{ toJSON(github) }} |
 | runner_context | internal (do not set): the "runner" context object in json | `true` | ${{ toJSON(runner) }} |
 
-
-
 <!-- action-docs-inputs -->
 <!-- action-docs-outputs -->
 
 <!-- action-docs-outputs -->
 
 ### Available commands
-* Generate  
-   Command that generates the provenance.
-* Help  
-   Command that prints helpful information about what commands and arguments can be used.
-* Version  
-   Command that prints version information about the binary that is used.
+
+- Generate
+  Command that generates the provenance.
+- Help
+  Command that prints helpful information about what commands and arguments can be used.
+- Version
+  Command that prints version information about the binary that is used.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-<!-- CONTRIBUTING -->
 ## Contributing
 
 If you have a suggestion that would make this project better, please fork the repository and create a pull request. You can also simply open an issue with the tag "enhancement".
@@ -177,32 +187,29 @@ Please refer to the [Contributing Guidelines](/CONTRIBUTING.md) for all the guid
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-<!-- LICENSE -->
 ## License
 
 Distributed under the MIT License. See [LICENSE](/LICENSE.md) for more information.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-<!-- CONTACT -->
 ## Contact
 
 *Powered by Philips SWAT Eindhoven*
 
-[Brend Smits](https://github.com/Brend-Smits) - brend.smits@philips.com  
-[Marco Franssen](https://github.com/marcofranssen)  
-[Jeroen Knoops](https://github.com/JeroenKnoops)  
-[Annie Jovitha](https://github.com/AnnieJovitha)  
+- [Brend Smits](https://github.com/Brend-Smits) - brend.smits@philips.com
+- [Marco Franssen](https://github.com/marcofranssen)
+- [Jeroen Knoops](https://github.com/JeroenKnoops)
+- [Annie Jovitha](https://github.com/AnnieJovitha)
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-<!-- ACKNOWLEDGMENTS -->
 ## Acknowledgments
 
 This project is inspired by:
 
-* [SLSA Framework](https://slsa.dev/)
-* [SLSA GitHub Action Example](https://raw.githubusercontent.com/slsa-framework/github-actions-demo)
+- [SLSA Framework](https://slsa.dev/)
+- [SLSA GitHub Action Example](https://raw.githubusercontent.com/slsa-framework/github-actions-demo)
 
 <p align="right">(<a href="#top">back to top</a>)</p>