All repositories should have a very well documented readme which provide the following information to the reader -
- Brief idea of the project along with relevant links
- Tech stack used
- System requirements
- Third party depenedencies or services used
- Deployment options
- Credentials required to run the project
- Environment variables required
An example of a readme in adherance to this format can be found in the readme.md file of this project here.