docs: add README.md file for project documentation

Ophestrarequested to merge
add-readme into main

This request adds build, configuration and API documentation.

Merge request reports