Add logo and contributor section

Add logo and contributor section
This commit is contained in:
Thomas Betous 2019-08-21 20:22:57 +02:00
parent 45fd5d3fed
commit 470a472c91
No known key found for this signature in database
GPG key ID: 03D4B5F30C344DF6
2 changed files with 17 additions and 6 deletions

View file

@ -1,4 +1,12 @@
<h1 align="center">How to promote my open-source? 🚀</h1> <h1 align="center">Open source project promotion cheat sheet</h1>
---
<p align="center">
<img alt="Git" src="./imgs/zoss-logo.png">
</p>
---
> This cheat sheet summarize important steps you should follow to promote your open-source project in the best conditions. > 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) - [English](./README.md)
- [Français](./README-fr.md) - [Français](./README-fr.md)
Your language is not here or you want to improve this document ? Contributors are [welcome](./CONTRIBUTING.md) !
<br /> <br />
## 1. 🎢 Preparation step ## 1. 🎢 Preparation step
@ -17,7 +27,7 @@ List of availables languages:
<summary>😎 Choose a cool name for your project</summary> <summary>😎 Choose a cool name for your project</summary>
<p> <p>
> 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)).
</p> </p>
</details> </details>
@ -45,8 +55,9 @@ List of availables languages:
<p> <p>
> 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: > 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 - An animated GIF demonstrating how your project works
- A link to a live demo - A link to a live demo
</p> </p>
</details> </details>
@ -141,12 +152,11 @@ List of availables languages:
</p> </p>
</details> </details>
<details> <details>
<summary>🗑 Don't spam platforms with your promotion</summary> <summary>🗑 Don't spam platforms with your promotion</summary>
<p> <p>
> 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.
</p> </p>
</details> </details>
@ -188,7 +198,7 @@ List of availables languages:
<summary>🏆 Reward contributors</summary> <summary>🏆 Reward contributors</summary>
<p> <p>
> 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)).
</p> </p>
</details> </details>
@ -198,6 +208,7 @@ List of availables languages:
<p> <p>
> Github issues are not always the best way to communicate with your users. Use chat platforms to discuss with them: > Github issues are not always the best way to communicate with your users. Use chat platforms to discuss with them:
- [Discord](https://discordapp.com) - [Discord](https://discordapp.com)
- [Slack](https://slack.com) - [Slack](https://slack.com)
- [Gitter](https://gitter.im/) - [Gitter](https://gitter.im/)

BIN
imgs/zoss-logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB