The README file for your project should provide a description and summary of the project. Here is an example mature repository for a project with a concise README file: https://github.com/raspberrypi/documentation
Think of the README as the "home page" for the project.