docs: update readme file and add missing documentation

4 jobs for issue/update-readme in 4 minutes and 25 seconds (queued for 9 seconds)
Status Name Job ID Coverage
  Build
passed build_test #731548

00:01:45

 
  Deploy
passed pages #731549

00:01:11

passed pages:deploy

00:00:00

 
  Preserve Pages
passed pushback #731550

00:01:27