docs: simplify readme for npm

[t1agob]

simplify readme file and point to full documentation

Signed-off-by: Tiago Barbosa tbarbos@hotmail.com

Description

This PR simplifies the README file (that is used for NPM) and points to the full documentation that will be the one-stop-shop for docs for all projects.

Type of change

• [ ] New feature (non-breaking change which adds functionality)
• [x] Fix (non-breaking change which fixes an issue)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

• [x] I have performed a self-review of this change
• [x] Changes have been tested
• [x] Changes are documented
• [x] Changes generate no new warnings
• [x] PR title follows conventional commit semantics

If this is a breaking change 👇

• [ ] I have documented the migration process
• [ ] I have implemented necessary warnings (if it can live side by side)

Acknowledgement

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.