Привести в порядок документ сервис

[AlIld]

Вам нужно привести в порядок свои репозитории, то есть отредактировать readme, перенести всё в мастер, доделать правки по личным комментариям от Олега.
По просьбе закидываю пример проекта с хорошим README
https://github.com/provectus/kafka-ui

В хорошем README должны быть описаны все необходимые технологии с командами для установки и необходимые настройки среды для развертывания проекта на чистой машине.
В идеале это должно быть описано для каждой и систем Linux, MacOS, Windows
Также должно содержаться базовое описание проекта и его особенностей, чтобы пользователь имел понимание с чем он работает, своего рода микродокументация.
И в целом нужно описать все моменты на которые должен обратить внимание пользователь, чтобы ему не приходилось искать ответы на вопросы в коде.