Многие репозитории в частности на гитхаб используют файлы типа README.md, куда обычно размещают документацию (или краткую её версию).
Для форматирования текста в ней часто используют разметку маркдаун.
