The idea for those badges is that the dev can quickly see the status of the tests & their coverage
A brief description of the system.. its core features/capabilities
Example: The example-system-name service is responsible for taking nomralized content and storing it in s3.
Check diagrams doc The idea is for the developer to be able to see where this system fits in the relevant architectural context. Give link to the proper diagram.
If there are nonstandard installation notes, here's where they'd go, but even if it's just a regular npm install or git clone, Its good to see that mentioned, too.
Any options, env variables etc that the system accepts should be descibed
Show how to run the system. Provide step by step series of examples and explanations if needed
Show how to run the system tests. Provide step by step series of examples and explanations if needed
Check API doc Provide swagger.yml or link to other resource where api is documented