instructions

• README.md files should describe the contents of the project they are in.
• if there are sub-projects they should have links to those projects
• they should be concise and clear
• where possible they should contain mermaid graphs that show the flow
• where possible they should contain mermaid sequences that show the sequence
• everything should be as simple as possible

example

see ticketmaster\tech-waiting-room-buffer\kafka\README.md see localDelivery\optimizedLocalDeliveryService\README.md

audience

• people who want to understand more about system's design and how to implement using those concepts