From 5e99089d144d8ed8ca29ac4b48fec9c405391c75 Mon Sep 17 00:00:00 2001
From: Thomas Betous
+
+
-> 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)).
> 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
How to promote my open-source? π
+Open source promotion cheat sheet
> This cheat sheet summarize important steps you should follow to promote your open-source project in the best conditions.
@@ -7,6 +11,8 @@ List of availables languages:
- [English](./README.md)
- [Français](./README-fr.md)
+A language is missing ? Want to improve this cheat sheet ? [Contributions are welcome](./CONTRIBUTING.md) !
+
## 1. π’ Preparation step
@@ -17,7 +23,7 @@ List of availables languages:
-> 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.
-> 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 +204,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.svg b/imgs/zoss-logo.svg new file mode 100644 index 0000000..fd72eae --- /dev/null +++ b/imgs/zoss-logo.svg @@ -0,0 +1,108 @@ + + +