You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -40,19 +40,19 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
40
40
<br />
41
41
42
42
<details>
43
-
<summary>π Make sure your project is mature enough</summary>
43
+
<summary>π Make sure that your project is mature enough</summary>
44
44
<p>
45
45
46
-
> Your project must be stable enough with minimum viable features in order to hook users.
46
+
> Your project must be stable enough with the minimum viable features in order to hook users.
47
47
48
48
</p>
49
49
</details>
50
50
51
51
<details>
52
-
<summary>π Choose a cool name for your project</summary>
52
+
<summary>π Choose a cool name for your cool project</summary>
53
53
<p>
54
54
55
-
> Choose a name users can easily remember.
55
+
> Choose a name that users can easily remember.
56
56
57
57
</p>
58
58
</details>
@@ -61,16 +61,16 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
61
61
<summary>π Make your README pretty</summary>
62
62
<p>
63
63
64
-
> README is the first thing your visitors will see. Make it simple, pretty and easy to read. [Here is a list of beautiful READMEs](https://github.com/matiassingers/awesome-readme).
64
+
> The README is the first thing your visitors will see. Make it simple, pretty and easy to read. [Here is a list of beautiful READMEs](https://github.com/matiassingers/awesome-readme).
65
65
66
66
</p>
67
67
</details>
68
68
69
69
<details>
70
-
<summary>πͺ Highlight strong points of your project</summary>
70
+
<summary>πͺ Highlight the strong points of your project</summary>
71
71
<p>
72
72
73
-
> Identify your project strengths and make sure visitors see them first.
73
+
> Identify your project's strengths and make sure visitors see them first.
74
74
75
75
</p>
76
76
</details>
@@ -79,7 +79,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
79
79
<summary>β¨ Provide a demo of your project</summary>
80
80
<p>
81
81
82
-
> Visitors 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:
82
+
> Visitors 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:
83
83
>
84
84
> - An animated GIF demonstrating how your project works
85
85
> - A link to a live demo
@@ -100,7 +100,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
100
100
<summary>π Create a clean and well structured documentation</summary>
101
101
<p>
102
102
103
-
> Creating a good documentation is probably the most important step. If you have a small documentation, you can include it within your README. Otherwise, you should probably host it in a separate website. Some open source projects like [vuepress](https://v1.vuepress.vuejs.org) can help you creating clean documentation in a simple way.
103
+
> Creating a good documentation is probably the most important step. If you have a small documentation, you can include it within your README. Otherwise, you should probably host it in a separate website. Some open source projects like [vuepress](https://v1.vuepress.vuejs.org) can help you with creating a clean documentation in a simple way.
104
104
105
105
</p>
106
106
</details>
@@ -121,10 +121,10 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
121
121
</details>
122
122
123
123
<details>
124
-
<summary>βοΈ Share the project on social media and specialized platforms</summary>
124
+
<summary>βοΈ Share your project on social media and specialized platforms</summary>
125
125
<p>
126
126
127
-
> Tell the World about your awesome work! Publish on social media and specialized platforms:
127
+
> Tell the World about your awesome work! Publish it on social media and other specialized platforms:
128
128
>
129
129
> -[Twitter](https://twitter.com)
130
130
> -[Linkedin](https://www.linkedin.com/)
@@ -144,7 +144,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
144
144
<summary>π Write articles that mention your project</summary>
145
145
<p>
146
146
147
-
> Write articles about your project. Purpose can be the technical stack you used, how your project works, problems you encountered, etc. Post to publishing platforms:
147
+
> Write articles about your project. Purpose can be the technical stack you used, how your project works, problems you encountered, etc. Post it to publishing platforms:
148
148
>
149
149
> -[medium](https://medium.com/)
150
150
> -[dev.to](https://dev.to/)
@@ -165,7 +165,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
165
165
<summary>π₯ Record and publish videos presenting your project, how it works, etc</summary>
166
166
<p>
167
167
168
-
> Recording a video is not an easy exercise. However it's probably the most efficient way to make your project famous.
168
+
> Recording a video is not an easy exercise. However, it's probably the most efficient way to make your project famous.
169
169
170
170
</p>
171
171
</details>
@@ -174,7 +174,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
174
174
<summary>π Choose the best time to publish on social media</summary>
175
175
<p>
176
176
177
-
> Don't publish during holidays period or weekends. Usually the best time to publish on social networks is mid-week.
177
+
> Don't publish during holiday periods or weekends. The best time to publish on social networks is usually mid-week.
178
178
179
179
</p>
180
180
</details>
@@ -183,7 +183,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
183
183
<summary>π Don't spam platforms with your promotion</summary>
184
184
<p>
185
185
186
-
> Don't publish twice on the same platform. It will be considered as spam and might cause bad publicity for your project.
186
+
> Don't publish twice on the same platform. It will be considered as spam and it might cause bad publicity for your project.
187
187
188
188
</p>
189
189
</details>
@@ -207,7 +207,7 @@ A language is missing? Want to improve this cheat sheet? [Contributions are welc
207
207
<summary>β Maintain your project, process opened issues</summary>
208
208
<p>
209
209
210
-
> Do not let opened issues without response. Be nice with people that took time to open issues. π
210
+
> Do not let issues stay open without a single response. Be nice with people that took the time to open issues. π
0 commit comments