🚀README File
Also known as README, README.md
The first file you read in a project. It says what the project is for.
Think of it like
Think of it like the sign on a shop door. It tells you what is inside and how to come in.
Example
Jack opens a new library on GitHub. Its README shows one install line and a short example. He is using it in two minutes.
Why it matters
Most people decide in seconds whether to use a project. The README is what they decide from.
Definition
Example code
markdown
# Tiny Dates
Formats dates in one line.
## Install
npm install tiny-datesCommon mistake
Key takeaways
- 1The front door. First file people read.
- 2What, install, use. The three answers.
- 3Shown by GitHub. On the repo's front page.