[Update] README

README.md

@@ -1,5 +1,33 @@
 # Net-Project-Package-Extractor
 
-A command line application that extracts all nuget information from .csproj files in a nested directory structure and saves the result to a spreadsheet.
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=RHEAGROUP_Net-Project-Package-Extractor&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=RHEAGROUP_Net-Project-Package-Extractor)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=RHEAGROUP_Net-Project-Package-Extractor&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=RHEAGROUP_Net-Project-Package-Extractor)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=RHEAGROUP_Net-Project-Package-Extractor&metric=coverage)](https://sonarcloud.io/summary/new_code?id=RHEAGROUP_Net-Project-Package-Extractor)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=RHEAGROUP_Net-Project-Package-Extractor&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=RHEAGROUP_Net-Project-Package-Extractor)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=RHEAGROUP_Net-Project-Package-Extractor&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=RHEAGROUP_Net-Project-Package-Extractor)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=RHEAGROUP_Net-Project-Package-Extractor&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=RHEAGROUP_Net-Project-Package-Extractor)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=RHEAGROUP_Net-Project-Package-Extractor&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=RHEAGROUP_Net-Project-Package-Extractor)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=RHEAGROUP_Net-Project-Package-Extractor&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=RHEAGROUP_Net-Project-Package-Extractor)
+[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=RHEAGROUP_Net-Project-Package-Extractor&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=RHEAGROUP_Net-Project-Package-Extractor)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=RHEAGROUP_Net-Project-Package-Extractor&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=RHEAGROUP_Net-Project-Package-Extractor)
 
-## usage
+The purpose of the Net-Project-Package-Extractor is process all the .csproj files in a directory (and subdirectories) and extract nuget information that is saved to a spreadsheet. This can be used as an appendix to the ECSS Software Reuse File. The Net-Project-Package-Extractor is available on [Nuget](https://www.nuget.org/packages/nppe) as a dotnet tool called `nppe`.
+
+Please read the [Quick Start](https://github.com/RHEAGROUP/Net-Project-Package-Extractor/wiki/Quick-Start) to find out how to use the `nppe` dotnet tool
+
+## Build Status
+
+GitHub actions are used to build and test the library
+
+Branch | Build Status
+------- | :------------
+Master | ![Build Status](https://github.com/RHEAGROUP/Net-Project-Package-Extractor/actions/workflows/CodeQuality.yml/badge.svg?branch=master)
+Development | ![Build Status](https://github.com/RHEAGROUP/Net-Project-Package-Extractor/actions/workflows/CodeQuality.yml/badge.svg?branch=development)
+
+# License
+
+The VCD-Generator libraries are provided to the community under the Apache License 2.0.
+
+# Contributions
+
+Contributions to the code-base are welcome. However, before we can accept your contributions we ask any contributor to sign the Contributor License Agreement (CLA) and send this digitaly signed to [email protected]. You can find the CLA's in the CLA folder.