Browse Source

:sparkles: Add logo and contributor section (#19)

* :sparkles: Add logo and contributor section
pull/20/head
Thomas Betous GitHub 9 months ago
parent
commit
5e99089d14
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 121 additions and 6 deletions
  1. +13
    -6
      README.md
  2. +108
    -0
      imgs/zoss-logo.svg

+ 13
- 6
README.md View File

@@ -1,4 +1,8 @@
<h1 align="center">How to promote my open-source? 🚀</h1>
<p align="center">
<img alt="oss image" src="./imgs/zoss-logo.svg" height="200px" width="200px">
</p>

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

@@ -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) !

<br />

## 1. 🎢 Preparation step
@@ -17,7 +23,7 @@ List of availables languages:
<summary>😎 Choose a cool name for your project</summary>
<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>
</details>
@@ -45,8 +51,9 @@ List of availables languages:
<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
- A link to a live demo

</p>
</details>
@@ -141,12 +148,11 @@ List of availables languages:
</p>
</details>


<details>
<summary>🗑 Don't spam platforms with your promotion</summary>
<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>
</details>
@@ -188,7 +194,7 @@ List of availables languages:
<summary>🏆 Reward contributors</summary>
<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>
</details>
@@ -198,6 +204,7 @@ List of availables languages:
<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/)


+ 108
- 0
imgs/zoss-logo.svg View File

@@ -0,0 +1,108 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- Generator: Adobe Illustrator 19.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Calque_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 2834.65 2834.65" style="enable-background:new 0 0 2834.65 2834.65;" xml:space="preserve">
<path style="fill:#B51733;stroke:#B51733;stroke-width:40;stroke-miterlimit:10;" d="M2156.992,1453.678
c0,52.796-5.729,104.245-16.594,153.772c-12.606,57.493-32.14,112.394-57.675,163.777c-14.77,29.729-31.562,58.286-50.178,85.488
l-0.206,0.297c-2.84,4.161-5.729,8.281-8.668,12.375c-76.333,106.532-181.238,191.211-303.506,242.826
c-85.364,36.036-179.191,55.966-277.682,55.966c-65.22,0-128.393-8.735-188.421-25.106
c-303.184-82.673-526.08-360.008-526.08-689.395c0-230.995,109.611-436.382,279.655-566.987
c120.451-92.522,271.226-147.522,434.846-147.522c184.466,0,352.611,69.901,479.369,184.664
C2066.27,1054.571,2156.992,1243.528,2156.992,1453.678z"/>
<g>
<g>
<polygon style="fill:#FFFFFF;" points="701.904,108.509 1808.701,1700.932 1025.218,2020.646 "/>
<path style="fill:#010202;" d="M727.88,172.166l1057.817,1521.952l-748.811,305.565L727.88,172.166 M688.048,67.424
c-3.942,0-7.735,3.367-6.905,8.276l330.905,1957.027c0.611,3.614,3.712,6.071,7.051,6.071c0.86,0,1.736-0.163,2.59-0.511
l801.876-327.22c4.166-1.7,5.63-6.932,2.999-10.717L693.783,70.542C692.275,68.373,690.14,67.424,688.048,67.424L688.048,67.424z"
/>
</g>
<g>
<polygon style="fill:#FFFFFF;" points="1879.388,1500.79 2147.47,1393.405 2282.875,1611.956 "/>
<path style="fill:#010202;" d="M2141.353,1412.013l108.621,175.32l-323.674-89.177L2141.353,1412.013 M2150.577,1376.568
c-0.917,0-1.845,0.171-2.739,0.529l-295.051,118.188c-6.555,2.625-6.024,12.075,0.783,13.95l444.078,122.35
c0.693,0.191,1.373,0.28,2.029,0.28c5.468,0,9.348-6.182,6.196-11.27l-149.028-240.538
C2155.468,1377.834,2153.067,1376.568,2150.577,1376.568L2150.577,1376.568z"/>
</g>
<g>
<polygon style="fill:#FFFFFF;" points="1691.931,1482.775 2133.891,1395.028 2048.047,1520.584 1867.532,1756.86 "/>
<path style="fill:#010202;" d="M2100.768,1416.898l-64.879,94.892l-167.276,218.949l-152.184-237.535L2100.768,1416.898
M2150.603,1376.568c-0.495,0-1.005,0.049-1.525,0.152l-470.905,93.494c-5.159,1.024-7.669,6.92-4.832,11.349l187.365,292.446
c1.46,2.279,3.871,3.438,6.29,3.438c2.21,0,4.426-0.968,5.927-2.933l187.164-244.98c0.08-0.104,0.156-0.21,0.23-0.319
l96.376-140.96C2160.168,1383.173,2156.349,1376.568,2150.603,1376.568L2150.603,1376.568z"/>
</g>
<g>
<polygon style="fill:#FFFFFF;" points="1121.296,1648.89 1034.769,2032.596 284.889,2527.022 "/>
<path style="fill:#010202;" d="M1094.724,1698.536l-73.258,324.865l-634.883,418.604L1094.724,1698.536 M1134.73,1616.238
c-1.839,0-3.72,0.704-5.259,2.32l-901.634,946.614c-4.915,5.16-0.478,12.54,5.286,12.54c1.332,0,2.735-0.394,4.11-1.301
l808.359-532.984c1.591-1.049,2.714-2.674,3.133-4.533l93.275-413.63C1143.155,1620.143,1139.058,1616.238,1134.73,1616.238
L1134.73,1616.238z"/>
</g>
<g>
<polygon style="fill:#FFFFFF;" points="815.343,61.757 1855.464,1765.896 1008.92,2048.83 "/>
<path style="fill:#010202;" d="M836.614,125.399l996.235,1632.24l-810.826,270.996L836.614,125.399 M804.633,22
c-3.991,0-7.923,3.187-7.444,8.107l197.73,2029.707c0.379,3.893,3.667,6.662,7.33,6.662c0.772,0,1.562-0.123,2.344-0.385
l864.706-289.004c4.492-1.501,6.423-6.789,3.955-10.832L810.819,25.551C809.315,23.088,806.963,22,804.633,22L804.633,22z"/>
</g>
<g>
<polygon style="fill:#FFFFFF;" points="199.014,2617.101 609.693,2185.993 187.392,2783.929 "/>
<path style="fill:#010202;" d="M479.287,2344.634l-273.204,386.828l7.519-107.928L479.287,2344.634 M675.913,2097.855
c-1.793,0-3.647,0.707-5.242,2.381l-484.413,508.508c-1.184,1.243-1.897,2.86-2.016,4.573l-13.709,196.78
c-0.333,4.783,3.512,7.903,7.444,7.903c2.184,0,4.395-0.963,5.931-3.138l498.121-705.288
C685.966,2104.001,681.202,2097.855,675.913,2097.855L675.913,2097.855z"/>
</g>
</g>
<path style="fill:#FFFFFF;" d="M1994.631,1145.737c-4.752-0.391-9.673-0.828-14.316-0.025c-7.966,1.378-15.85,3.435-23.609,5.761
c-3.581,1.073-6.936,3.197-10.101,5.287c-3.936,2.595-7.471,2.391-10.739-1.24c-1.194-1.325-2.36-2.681-3.588-3.973
c-3.344-3.525-6.692-7.046-10.04-10.566c0.954-0.974,0.526-0.537,1.48-1.511l0.323,0.295c0.263,0.239,0.669,0.219,0.905-0.046
c0.051-0.057,0.102-0.114,0.153-0.172c0.236-0.264,0.212-0.67-0.055-0.904c-5.744-5.034-11.271-10.36-17.375-14.914
c-3.287-2.45-7.02-0.414-9.562,2.375c-2.511,2.757-2.165,5.973-0.085,8.957c4.371,6.258,8.904,12.405,13.126,18.757
c2.2,3.309,3.975,6.899,5.654,9.949c0.186,0.337,0.032,0.755-0.325,0.897c-64.228,25.466-128.109,50.8-191.903,76.099
c-0.598,0.237-1.131-0.459-0.747-0.975c0.935-1.258,1.939-2.606,2.991-3.914c33.548-41.712,67.18-83.361,100.633-125.145
c13.284-16.586,26.349-33.353,39.186-50.287c4.096-5.4,7.592-11.377,10.545-17.488c4.623-9.575-0.44-17.073-11.016-16.858
c-3.387,0.07-6.836,0.396-10.127,1.161c-25.169,5.849-48.569,16.27-71.512,27.86c-1.263,0.641-2.699,1.587-3.975,1.472
c-10.452-0.939-20.883-2.076-30.957-3.121c-0.466-0.048-0.717-0.566-0.475-0.966c17.331-28.685,34.505-56.985,51.548-85.361
c10.27-17.107,20.326-34.341,30.497-51.503c3.468-5.855,2.701-14.343-1.75-17.314c-9.624-6.421-20.007-9.126-31.501-6.218
c-4.406,1.111-6.84,4.626-7.081,9.24c-0.18,3.415-0.632,7.061-2.013,10.126c-3.937,8.732-8.233,17.312-12.701,25.786
c-19.717,37.424-43.855,72.107-66.777,107.537c-0.847,1.306-3.432,2.216-5.138,2.12c-10.705-0.592-21.378-1.686-32.076-2.31
c-31.959-1.859-63.882-2.873-95.797,1.278c-23.412,3.046-39.728,17.198-54.674,33.586c-1.693,1.858-2.221,6.512-1.059,8.677
c0.922,1.72,5.488,2.694,8.025,2.135c12.827-2.841,25.527-6.253,38.243-9.567c1.009-0.265,1.97-0.714,2.922-1.197
c-0.251-1.181-0.221-1.043-0.472-2.225c-0.241-0.012-0.485-0.023-0.734-0.036c-0.734-0.035-0.848-1.079-0.136-1.258
c28.636-7.201,109.63-12.61,134.516-9.302c0.759,0.101,0.729,1.205-0.033,1.271c-0.104,0.009-0.209,0.018-0.313,0.027
c0.039,2.282,0.023,1.376,0.062,3.658c15.801,0.83,31.601,1.66,47.398,2.491c0.301,0.016,0.55,0.24,0.597,0.539l0.075,0.475
c0.044,0.281-0.102,0.558-0.359,0.679c-6.101,2.887-12.353,5.505-18.25,8.762c-17.164,9.473-34.167,19.232-51.252,28.844
c-21.816,12.272-43.607,24.587-65.497,36.727c-11.902,6.597-17.632,16.765-18.386,30.082c-0.263,4.636,0.457,9.054,5.098,11.193
c4.729,2.178,8.197-0.58,11.652-3.684c6.713-6.033,13.348-12.254,20.661-17.489c15.316-10.958,30.831-21.674,46.66-31.871
c41.812-26.933,84.719-52.036,128.997-74.715c8.058-4.124,16.674-7.169,25.099-10.578c0.852,1.095,0.77,0.99,1.622,2.086
c-0.487,0.658-0.98,1.309-1.5,1.938c-36.498,43.909-72.879,87.916-109.564,131.664c-19.781,23.594-39.915,46.903-60.235,70.037
c-9.12,10.384-11.998,21.613-7.45,34.642c1.763,5.054,3.666,10.079,5.812,14.981c11.903,27.183,29.139,51.019,47.422,74.076
c18.709,23.595,41.016,24.595,64.343,12.373c2.104-1.099,4.406-4.691,4.104-6.763c-0.359-2.446-3.177-4.836-5.433-6.608
c-1.684-1.331-4.346-1.339-6.259-2.469c-18.642-10.989-36.507-22.921-50.436-39.957c-10.662-13.043-19.451-27.189-26.638-42.364
c-2.229-4.711-1.046-8.259,3.677-10.494c3.333-1.576,6.993-2.63,10.619-3.384c26.925-5.611,54.18-8.244,81.66-8.761
c43.442-0.827,86.629,3.307,129.858,6.653c2.899,0.226,5.826,0.114,8.741,0.138c0.63,0.099,1.251,0.195,1.881,0.294
c1.638,0.527,3.219,1.426,4.899,1.69c12.991,2.024,25.969,4.239,39.02,5.775c6.219,0.733,12.73,0.964,18.87-0.038
c17.058-2.79,26.072-15.568,22.658-31.828c-1.047-4.992-2.92-10.169-5.745-14.362c-8.983-13.303-18.497-26.255-28.004-39.201
c-4.797-6.526-9.978-12.769-15.324-19.533c-0.256-0.324-0.14-0.801,0.233-0.977c4.204-1.983,7.727-4.536,11.438-4.843
c8.935-0.734,13.554-6.597,18.195-12.878c2.011-2.675,4.192-5.246,5.926-8.094c0.44-0.723-0.375-2.211-0.69-3.399
c-0.028-0.106-0.024-0.215,0.004-0.322C1999.86,1149.359,1999.315,1146.124,1994.631,1145.737z M1953.787,1226.13
c4.696,11.071,8.293,22.618,12.115,34.045c1.135,3.382-0.979,4.187-4.01,3.588c-10.447-2.06-20.893-4.127-31.361-6.088
c-7.558-1.416-15.099-3.3-22.738-3.879c-29.168-2.198-58.364-3.974-87.56-5.833c-2.551-0.162-5.693-0.414-4.219,3.639
c0.158,0.434-0.172,0.892-0.633,0.869c-7.118-0.361-13.555-0.683-20.385-1.03c-0.495-0.025-0.778-0.579-0.504-0.991
c0.46-0.693,0.935-1.409,1.633-2.46c0.279-0.419-0.02-0.982-0.522-0.994c-11.63-0.272-22.514-0.527-33.338-0.781
c-0.216-1.116-0.177-0.914-0.394-2.03c3.595-1.559,7.177-3.147,10.826-4.559c20.609-7.966,41.277-15.791,61.858-23.824
c4.479-1.745,8.607-4.385,13.075-6.144c2.883-1.13,6.101-1.38,9.159-2.067c3.428-0.77,6.909-1.385,10.261-2.42
c12.249-3.792,24.384-7.963,36.695-11.534c7.82-2.267,15.894-3.625,23.809-5.568c5.398-1.324,6.303,3.516,8.173,6.196
c2.8,3.999,4.272,8.888,6.735,13.154C1946.107,1213.743,1950.969,1219.488,1953.787,1226.13z"/>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
</svg>

Loading…
Cancel
Save