Skip to content

README files

Barrie Byron edited this page Jul 11, 2023 · 7 revisions

README files are the welcome sign for the project and form the first impression of the project for new users and potential contributors.

The README content keeps essential information close to the code and signals that a community is active. A quality README elevates the quality of any project and shares information that makes the project more attractive to contributors.

README content

  1. Title
  2. A few short statements describing why your project exists and what it does
  3. Installation and dependencies
  4. Usage instructions
  5. How users can get help
  6. Links to essential documentation
    • Use absolute links so that the links work on npm
  7. Link to your project's license

Nice to haves

  • Table of contents
  • Tech stack and features
  • A link to a working instance
  • A screenshot of the project's user interface
  • Link to contributing guidelines
  • Link to code of conduct
  • Badges
  • Tests
  • Code examples and how to run them
Clone this wiki locally