improve repo documentation

[xmonader]

checklist

• have an introduction to the project
• show status of the tests and code coverage
• how to run in production e.g if it was a binary or something the enduser needs to download
• how to run in development as a developer (it's fine to link to another page)
• should have a link to internal docs for development
  • how to get the code
  • how to configure the editor/IDE
  • how to run the tests
  • how to write new tests
  • have the workflows documented
  • have the releasing process documented

[xmonader]

also we need to add some more examples for endusers on how to use zinit too

[khaledyoussef24]

can we also add a best practice of how to use the manditory parts like

1. ufw service
2. ssh service
3. which ports should we use in our images if we will use a gate way from the grid