O arquivo README é o documento principal de um repositório no GitHub — funciona como um cartão de visitas do projeto para outros desenvolvedores, recrutadores e potenciais colaboradores. Um README bem feito precisa ter descrição e objetivo do projeto, lista de funcionalidades, instruções de instalação e uso, tecnologias utilizadas, exemplos de uso e dados de contato do desenvolvedor.
Fonte: Tech Tudo