diff --git a/README.md b/README.md index 7b980af..f9c8682 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ -

How to promote my open-source? πŸš€

+

Open source project promotion cheat sheet

+ +--- + +

+ Git +

+ +--- > This cheat sheet summarize important steps you should follow to promote your open-source project in the best conditions. @@ -7,6 +15,8 @@ List of availables languages: - [English](./README.md) - [Français](./README-fr.md) +Your language is not here or you want to improve this document ? Contributors are [welcome](./CONTRIBUTING.md) ! +
## 1. 🎒 Preparation step @@ -17,7 +27,7 @@ List of availables languages: 😎 Choose a cool name for your project

-> 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)). +> 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)).

@@ -45,8 +55,9 @@ List of availables languages:

> Vistors will want to quickly understand the purpose of your project, how it works and how to use it. Providing a demo is the best way to satisfy users. It could be: + - An animated GIF demonstrating how your project works -- A link to a live demo +- A link to a live demo

@@ -141,12 +152,11 @@ List of availables languages:

-
πŸ—‘ Don't spam platforms with your promotion

-> Don't publish twice on the same platform. It will be considered as spam and might cause bad publicity for your project. +> Don't publish twice on the same platform. It will be considered as spam and might cause bad publicity for your project.

@@ -188,7 +198,7 @@ List of availables languages: πŸ† Reward contributors

-> 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, do a public post (on twitter or other platforms) about the contribution and mention the author ([here is an example of tweet](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Open a `Contributors` section in your README to publicly thanks them (ex: [vuepress contributors section](https://github.com/vuejs/vuepress#code-contributors)). +> 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, do a public post (on twitter or other platforms) about the contribution and mention the author ([here is an example of tweet](https://twitter.com/FranckAbgrall/status/1139470547492978688)). Open a `Contributors` section in your README to publicly thanks them (ex: [vuepress contributors section](https://github.com/vuejs/vuepress#code-contributors)).

@@ -198,6 +208,7 @@ List of availables languages:

> 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/) diff --git a/imgs/zoss-logo.png b/imgs/zoss-logo.png new file mode 100644 index 0000000..cacae7b Binary files /dev/null and b/imgs/zoss-logo.png differ