Write a README

You write the README on the project’s Readme screen. The body is written in Markdown.

Only Owner and Maintainer can write the README. Writer and Reader can view it.

Write and save a README

Write text describing the contents of the project and save it.

1. On the project’s Readme screen, click Edit.
2. Enter the body on the Edit tab.
3. Open the Preview tab and check how it looks.
4. Click Save Changes.