feature: fixed the readme, added more comprehensive notes

Adam Faraidon Wahabrequested to merge
feature/comprehensiveReadMe into main

title :))

Merge request reports