As a developer of the CoMPAS community I would like to have a README.md that would describe the whole purpose of the repo and a brief guide of how to run scripts for all components, plugins and how to demo them as well, so that it's clearer how to navigate through it.
Acceptance criteria
The README.md file has a brief summary of its purpose
There is a list of components featured in the repo
A small example of how to use the scripts added to the root package.json and what to expect from them
User Story
As a developer of the CoMPAS community I would like to have a README.md that would describe the whole purpose of the repo and a brief guide of how to run scripts for all components, plugins and how to demo them as well, so that it's clearer how to navigate through it.
Acceptance criteria
package.jsonand what to expect from them