O principal propósito por trás de um arquivo README em um repositório do GitHub é apresentar a ferramenta a um possível novo contributor e servir de guia de referência para um contributor regular.
Um bom README deve ser conciso e objetivo, o site Make a Readme sugere alguns tópicos e é baseado em se questionar O que, Por que, Como, Quando, Onde e Quem. Além disso oferece um exemplo simples, somos livres para inserir mais coisa como Badges, Videos, GIFs, Imagens, Links e Referências, mas lembre-se de manter o foco no conteúdo objetivo, o principio do KISS se aplica aqui.
Referências: