-
+> Choose a name users can easily remember. It must not necessarly includes keywords related to the technology you're using within your project (ex: [bento-starter](https://github.com/kefranabg/bento-starter)).
- > [List of beautiful readmes](https://github.com/matiassingers/awesome-readme).
+Details
-
-- β¨ Provide a demo of your project +> README is the first your user will see. Make it simple, pretty and easy to read. [Here is a list of beautiful READMEs](https://github.com/matiassingers/awesome-readme). -- π Insall/Usage must be super easy +
++ +> Identify your project strengths and make sure that visitors see them at first. + +
++ +> README is the first your user will see. Make it simple, pretty and easy to read. [Here is a list of beautiful READMEs](https://github.com/matiassingers/awesome-readme). + +
++ +> You'll probably lost users if your project is not user friendly. + +
++ +> It is probably the most important step. If your have a small documentation, you can include it in your README. Otherwise, you should probably host it in a different website. Projects like [vuepress](https://v1.vuepress.vuejs.org) helps you creating clean documentations in a simple way. + +
+
+
- > A minimum of stars make your project more trustable then a zero star project.
+> A minimum stars amount make your project more trustable than a zero star project. Ask people you know to support your project before doing a public annouccement on social medias.
- β Talk about your project to your friends and colleagues to get your first github stars before publishing to social networks
+
-- π Write articles that mention your project +> Tell the world about your awesome project! Publish on social medias and specialized platforms: -- π Take care to choose the best time to post and share articles +- [Twitter](https://twitter.com) +- [Linkedin](https://www.linkedin.com/) +- [Facebook](https://www.facebook.com/) +- [Reddit](https://www.reddit.com/) +- [Dev.to](https://dev.to/) +- [Lobsters](https://lobste.rs/) +- [Hacker News](https://news.ycombinator.com/) +- [Product Hunt](https://www.producthunt.com/) +- [Beta page](https://betapage.co/) +- [Human Coders](https://news.humancoders.com/) +
++ +> Write articles to talk about your project (purpose can be the technical stack you used, how your project works, problems you encountered, etc). Publish your articles to [medium](https://medium.com/) or [dev.to](https://dev.to/). + +
++ +> Presenting your project at conferences or meetupss is a good way to improve its visibility. + +
++ +> Like conferences, recording is not an easy execise, but it's a great way to get your project famous. + +
++ +> Don't publish during holidays period or weekends. Usually the best time to publish on social networks is mid-week. + +
++ +> Don't publish twice on the same platform. It will be considered as spam and might cause bad publicity for your project. + +
+-- π Invite users to contribute +> Maintain and improve your project with new releases. Generate changelogs is also a best practice to let your users know about changes. -- π Reward contributors +
+-- π Ask for feedback +> Do not let opened issues without response. Be nice with people that took time to open an issue π + +
++ +> A healthy project is a project with a community and contributors. Let your users know that you need helps by tagging some issues with `contribution welcome` or `good first issue` labels. + +
++ +> Be nice with people that helped you! Some open-source projects like [gatsby](https://github.com/gatsbyjs/gatsby) reward contributors with goodies. If you can't afford that (which is probably the case), tweet about the contribution and mention the author ([here is an example of tweet](https://twitter.com/FranckAbgrall/status/1139470547492978688)) open a `Contributors` section to your README in order to publicly thanks them (ex: [vuepress contributors section](https://github.com/vuejs/vuepress#code-contributors)). + +
++ +> Github issues are not always the best way to communicate with your users. Use chat platforms to discuss with them: +- [Discord](https://discordapp.com) +- [Slack](https://slack.com) +- [Gitter](https://gitter.im/) + +
++ +> User's feedback is the best way to improve your project + +
++ +> Visitors will trust your project if they see concrete use cases (ex: [vuepress gallery](https://vuepress.gallery/)) + +
+