PROJECT TITLE

A short description of what the project is all about.

Contents

Dependencies
Setup
Usage
Issues
References

Dependencies

Development Environment
- Libraries
- Tools
- Link to requirements.txt, package.json,..
Production Environment
- deployment platform

Setup

How to install project dependencies
How to install the application
..

Usage

How to use the application
..

Issues

List of known issues and troubleshooting steps
Link to the ISSUES.md file

References

3rd-party API documentations
Technical articles, blogs, cources, etc.