В этом файле нужно кратко описать:
Информацию для разработчиков, которые будут работать с этим репозиторием, или просто зайдут посмотреть проект.
Например консольные команды для запуска локальной версии или запуска тестов.
Особенности архитектуры или специфические библиотеки.
Главное помнить: больше одного экрана текста не всякий читатель осилит. Поэтому лучше кратко и по делу.