A few sentences of introduction that explain what the project does.
Step-by-step installation instructions, including commands to install dependencies.
npm install
How to run the project and what to expect. Eg:
To start this project, run
npm start
Notes on any important development concepts you might forget or other users might want to know. Eg
"to create a new scraper, use the knight scraper in the scrapers directory as an example".
Notes on how to run the tests (if any)
Optional troubleshooting notes for common bugs.