README.md é um arquivo com extensão .md (Markdown). Contém informações necessárias para entender o objetivo do projeto. README é uma palavra em inglês que traduzida fica LEIAME.

Podemos considerar o README como um cartão de visita do seu projeto no Github ou em outras plataformas de repositórios remotos de código: Gitlab, Bitbucket, Azure Repos.

Como escrever um README?

Reademe.so - é um simples editor permite adicionar e personalizar facilmente todas as seções que você precisa para o README do seu projeto