Tips for creating an effective README on GitHub

Tips for creating a README

1. Start with one sentence

The first line of the README should explain in one sentence what your project does.

2. Add a quick start

A minimum usage example of 3-5 lines of code should be at the beginning of the README.

3. Use GIFs instead of screenshots

Animated GIF demos better convey the interactivity of a project.

4. Keep it relevant

An outdated README is worse than a missing README. Update it along with the code.

5. Add a table of contents

For long READMEs, create a table of contents with anchor links for navigation.

6. Specify compatibility

List supported language, OS and dependency versions.

7. Real-life examples

Show real use cases, not just abstract examples.

8. Templates for Issues and PR

In addition to the README, create templates for issues and pull requests to make it easier to contribute to the project.

9. Multilingual README

For international projects, create READMEs in multiple languages.

See also: Diff Checker, YAML ↔ JSON, JSON Formatter