Разработчики flask-base рассказывают, как они продвигали свой проект.

Самой важной частью продвижения было создание хорошего README.

README — это первое, что видят посетители репозитория. Он должен отвечать на все их вопросы. У популярных проектов README обычно строится по такой структуре:

1. Название. Можно нарисовать логотип, тогда проект будет казаться более серьезным.
2. Короткое описание. Оно должно помещаться в твит. Ради этого можно пожертвовать деталями.
3. Бейджи, которые показывают качество кода. Когда значки говорят, что билд зеленый, тестовое покрытие высокое, а статический анализ не находит проблем, это сразу вызывает доверие. Пользователю не приходится заглядывать в исходники, чтобы убедиться, что код написан хорошо.
4. Ссылка на документацию, которая рассказывает, как пользоваться проектом. Написать хорошую документацию тяжело, но критически важно для успеха проекта.
5. Список фич. Не обязательно полный, оптимальный размер — до десяти.
6. Пример работы. В идеале это должна быть гифка, которая показывает, как работает проект. Ничего страшного, если даже на гифке будет просто показана консоль. Картинка произведет большее впечатление, чем если написать то же самое текстом.
7. Инструкции по установке с командами, которые пользователь должен ввести, чтобы на его компьютере всё заработало.