Uma beleza.
Imagina chegar em um projeto e o README tá vazio?!
Gosto muito de laravel e a maioria do projetos deixa o README original do laravel, que nada diiz sobre o projeto.
Importante documentar o projeto no READMR e quando o projeto for importane criar uma pasta docs com um site de documentação (sugestão: mkdocs).
Outro detalhe importaante, quando for o caso, fornecer um script sql paara ovisitante testar o projeto com facilidade.
Muito grato.
Em resposta a Personalizando o README do seu perfil do GitHub
1