Если вы, как и я раньше, наивно полагаете, что потенциальные рекрутеры хотя бы откроют ваш гитхаб, то глубоко ошибаетесь. Подавляющему большинству из них на это плевать. Если и делать README, то не для работодателя (ему нужен коммерческий опыт) и не для пользователя (ему хорошо бы интерактивное обучение в самом приложении и интуитивно-понятный интерфейс), а для отработки навыков (тогда описание нужно делать для себя, чтоб потом быстро найти и вспомнить) или для решения прикладной задачи, которая может пригодится другим разработчикам (тогда хорошо бы писать нормальный читаемый код и добавлять примеры использования). В любом случае, оформление из статьи не может служить хорошим примером.
Если бы вторая причина была надуманной, то давно бы написали множество привычных офисных программ для непродвинутого пользователя. А пока что даже офисные пакеты часто некорректно сохраняют и открывают файлы в форматах MS Office. Что уж говорить о более сложных продуктах.
Вижу статью в поддержку строгой типизации - ставлю плюс.
Если вы, как и я раньше, наивно полагаете, что потенциальные рекрутеры хотя бы откроют ваш гитхаб, то глубоко ошибаетесь. Подавляющему большинству из них на это плевать. Если и делать README, то не для работодателя (ему нужен коммерческий опыт) и не для пользователя (ему хорошо бы интерактивное обучение в самом приложении и интуитивно-понятный интерфейс), а для отработки навыков (тогда описание нужно делать для себя, чтоб потом быстро найти и вспомнить) или для решения прикладной задачи, которая может пригодится другим разработчикам (тогда хорошо бы писать нормальный читаемый код и добавлять примеры использования). В любом случае, оформление из статьи не может служить хорошим примером.