Improve cheat sheet description (#21)

This commit is contained in:
Franck Abgrall 2019-08-23 15:07:22 +02:00 committed by GitHub
parent 8dfa12418e
commit 2a421df34f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2,9 +2,16 @@
<img alt="oss image" src="./imgs/zoss-logo.svg" height="200px" width="200px">
</p>
<h1 align="center">Open source promotion cheat sheet</h1>
<p align="center">
<a href="https://twitter.com/intent/tweet?text=How%20to%20promote%20your%20open-source%20projects&url=https://github.com/zenika-open-source/open-source-promotion-cheat-sheet&hashtags=OpenSource,CheatSheet">
<img alt="tweet" src="https://img.shields.io/twitter/url/https/twitter?label=Share%20on%20twitter&style=social" target="_blank" />
</a>
</p>
> This cheat sheet summarize important steps you should follow to promote your open-source project in the best conditions.
<h1 align="center">Open source promotion cheat sheet </h1>
> This cheat sheet summarize important steps you should follow to promote your open-source project in the best conditions. You can click items to expand and get more information from a topic.
List of availables languages:
@ -13,8 +20,6 @@ List of availables languages:
A language is missing ? Want to improve this cheat sheet ? [Contributions are welcome](./CONTRIBUTING.md) !
<br />
## 1. 🎢 Preparation step
<br />
@ -51,9 +56,9 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we
<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:
- An animated GIF demonstrating how your project works
- A link to a live demo
>
> - An animated GIF demonstrating how your project works
> - A link to a live demo
</p>
</details>
@ -204,10 +209,10 @@ A language is missing ? Want to improve this cheat sheet ? [Contributions are we
<p>
> 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/)
>
> - [Discord](https://discordapp.com)
> - [Slack](https://slack.com)
> - [Gitter](https://gitter.im/)
</p>
</details>