A good README document contains the following:
Name: What is the name of the product? Does the product go by other names as well, and if so, what are the other names?
Description: What is the purpose of this product? Describe in one or two sentences. It needs to be understandable for people unfamiliar with the product.
Who owns it: Which team or person is the point of contact?
Stage: What is the stage of this product? Is it in development, active, deprecated, or obsolete?
Endpoints: If this product is a web app or web service, where can it be reached? Include information for all environments (production, staging, sandbox, and others).
Requirements/dependencies: What needed to develop and/or run this product?
Which application dependencies does this product have? This includes databases and other (web) services. It might also include Docker, which provides Docker Compose, an easy way to run dependencies.
How do I…: Describe basic tasks. These should all be simple and straightforward.
How do I deploy/release it? For example, run bin