Что писать в «README.md» (GitHub)?
Каких-то правил нет.

Обычно указывают:
1. Установка
2. Описание
3. Документация
4. Авторы
5. Лицензия

Ваш репозиторий - ваши правила, делайте как хотите.
Правил нет, но попытку стандартизации можно найти. Например:
https://github.com/RichardLitt/standard-readme