Lesson 5 / 20

README Files

Write a clear README.md that explains what a project does and how to install and run it.

Why a README matters

README.md is rendered right on the repo's home page — explain what the project does and how to run it.

Basic structure

A short, scannable README beats a long one — title, what it does, how to install and run it.

# My App

A short description of what this project does.

## Installation

```bash
npm install
```

## Usage

```bash
npm start
```

Badges & docs

Badges (build status, license) and a CONTRIBUTING.md set expectations for anyone who wants to contribute.