Skip to content

Commit e6a6384

Browse files
authored
docs: improve readme syntax (#2106)
1 parent 7accd1a commit e6a6384

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

readme.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@
6868
<img src="https://indiaspora.org/wp-content/uploads/2021/04/give-India-logo.png" alt="Give india logo" width="200" />
6969
</a>
7070

71-
Are you considering supporting the project by donating? Please DON'T!!
71+
Are you considering supporting the project by donating? Please DO NOT!!
7272

73-
Instead, Help India fight the 2nd deadly wave of COVID-19.
73+
Instead, Help India fight the second deadly wave of COVID-19.
7474
Thousands of people are dying in India because of a lack of Oxygen & also COVID-related infrastructure.
7575

7676
Visit <https://indiafightscorona.giveindia.org> and make a small donation to help us fight COVID and overcome this crisis. A small donation goes a long way. :heart:
@@ -94,7 +94,7 @@ Visit <https://indiafightscorona.giveindia.org> and make a small donation to hel
9494

9595
# GitHub Stats Card
9696

97-
Copy-paste this into your markdown content, and that's it. Simple!
97+
Copy-paste this into your markdown content, and that is it. Simple!
9898

9999
Change the `?username=` value to your GitHub username.
100100

@@ -108,7 +108,7 @@ The implementation can be investigated at [src/calculateRank.js](./src/calculate
108108

109109
### Hiding individual stats
110110

111-
To hide any specific stats, you can pass a query parameter `&hide=` with comma-separated values.
111+
You can pass a query parameter `&hide=` to hide any specific stats with comma-separated values.
112112

113113
> Options: `&hide=stars,commits,prs,issues,contribs`
114114
@@ -120,7 +120,7 @@ To hide any specific stats, you can pass a query parameter `&hide=` with comma-s
120120

121121
You can add the count of all your private contributions to the total commits count by using the query parameter `&count_private=true`.
122122

123-
_Note: If you are deploying this project yourself, the private contributions will be counted by default. Otherwise, you need to choose to share your private contribution counts._
123+
_Note: If you are deploying this project yourself, the private contributions will be counted by default. If you are using the public Vercel instance, you need to choose to [share your private contributions](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile)._
124124

125125
> Options: `&count_private=true`
126126
@@ -148,15 +148,15 @@ Use `&theme=THEME_NAME` parameter like so :
148148

149149
#### All inbuilt themes
150150

151-
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
151+
Github readme stats comes with several built-in themes (e.g. `dark`, `radical`, `merko`, `gruvbox`, `tokyonight`, `onedark`, `cobalt`, `synthwave`, `highcontrast`, `dracula`).
152152

153153
<img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="GitHub Readme Stats Themes" width="600px"/>
154154

155155
You can look at a preview for [all available themes](./themes/README.md) or checkout the [theme config file](./themes/index.js) & **you can also contribute new themes** if you like :D
156156

157157
### Customization
158158

159-
You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL params.
159+
You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL parameters.
160160

161161
#### Common Options
162162

@@ -175,11 +175,11 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
175175
176176
##### Gradient in bg_color
177177

178-
You can provide multiple comma-separated values in the bg_color option to render a gradient, with the following format:
178+
You can provide multiple comma-separated values in the bg_color option to render a gradient with the following format:
179179

180180
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
181181

182-
> Note on cache: Repo cards have a default cache of 4 hours (14400 seconds) if the fork count & star count is less than 1k, otherwise, it's 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours.
182+
> Note on cache: Repo cards have a default cache of 4 hours (14400 seconds) if the fork count & star count is less than 1k; otherwise, it is 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours.
183183
184184
#### Stats Card Exclusive Options
185185

@@ -190,7 +190,7 @@ You can provide multiple comma-separated values in the bg_color option to render
190190
- `show_icons` - _(boolean)_. Default: `false`.
191191
- `include_all_commits` - Count total commits instead of just the current year commits _(boolean)_. Default: `false`.
192192
- `count_private` - Count private commits _(boolean)_. Default: `false`.
193-
- `line_height` - Sets the line-height between text _(number)_. Default: `25`.
193+
- `line_height` - Sets the line height between text _(number)_. Default: `25`.
194194
- `exclude_repo` - Exclude stars from specified repositories _(Comma-separated values)_. Default: `[] (blank array)`.
195195
- `custom_title` - Sets a custom title for the card. Default: `<username> Github Stats`.
196196
- `text_bold` - Use bold text _(boolean)_. Default: `true`.
@@ -205,7 +205,7 @@ You can provide multiple comma-separated values in the bg_color option to render
205205

206206
#### Language Card Exclusive Options
207207

208-
- `hide` - Hide the languages specified from the card _(Comma-separated values)_ .Default: `[] (blank array)`.
208+
- `hide` - Hide the languages specified from the card _(Comma-separated values)_. Default: `[] (blank array)`.
209209
- `hide_title` - _(boolean)_. Default: `false`.
210210
- `layout` - Switch between two available layouts `default` & `compact`. Default: `default`.
211211
- `card_width` - Set the card's width manually _(number)_. Default `300`.
@@ -214,27 +214,27 @@ You can provide multiple comma-separated values in the bg_color option to render
214214
- `custom_title` - Sets a custom title for the card _(string)_. Default `Most Used Languages`.
215215

216216
> :warning: **Important:**
217-
> Language names should be uri-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
217+
> Language names should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
218218
> (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use
219219
> [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
220220
221221
#### Wakatime Card Exclusive Options
222222

223223
- `hide` - Hide the languages specified from the card _(Comma-separated values)_. Default: `[] (blank array)`.
224224
- `hide_title` - _(boolean)_. Default `false`.
225-
- `line_height` - Sets the line-height between text _(number)_. Default `25`.
225+
- `line_height` - Sets the line height between text _(number)_. Default `25`.
226226
- `hide_progress` - Hides the progress bar and percentage _(boolean)_. Default `false`.
227227
- `custom_title` - Sets a custom title for the card _(string)_. Default `Wakatime Stats`.
228228
- `layout` - Switch between two available layouts `default` & `compact`. Default `default`.
229-
- `langs_count` - Limit the number of languages on the card, defaults to all reported languages _(number)_. Default `50`.
230-
- `api_domain` - Set a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) _(string)_. Default `Wakapi`.
229+
- `langs_count` - Limit the number of languages on the card, defaults to all reported languages _(number)_.
230+
- `api_domain` - Set a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) _(string)_. Default `Waka API`.
231231
- `range` – Request a range different from your WakaTime default, e.g. `last_7_days`. See [WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options. _(YYYY-MM, last_7_days, last_30_days, last_6_months, last_year, or all_time)_. Default `all_time`.
232232

233233
* * *
234234

235235
# GitHub Extra Pins
236236

237-
GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
237+
GitHub extra pins allow you to pin more than six repositories in your profile using a GitHub readme profile.
238238

239239
Yay! You are no longer limited to 6 pinned repositories.
240240

@@ -260,7 +260,7 @@ Use [show_owner](#customization) variable to include the repo's owner username
260260

261261
The top languages card shows a GitHub user's most frequently used top language.
262262

263-
_NOTE: Top Languages does not indicate my skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It's a new feature of github-readme-stats._
263+
_NOTE: Top Languages does not indicate my skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of github-readme-stats._
264264

265265
### Usage
266266

@@ -274,7 +274,7 @@ Endpoint: `api/top-langs?username=anuraghazra`
274274

275275
### Exclude individual repositories
276276

277-
You can use `&exclude_repo=repo1,repo2` parameter to exclude individual repositories.
277+
You can use the `&exclude_repo=repo1,repo2` parameter to exclude individual repositories.
278278

279279
```md
280280
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io)](https://github.com/anuraghazra/github-readme-stats)
@@ -382,15 +382,15 @@ Choose from any of the [default themes](#themes)
382382

383383
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
384384

385-
- Wakatime card
385+
- WakaTime card
386386

387387
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats)
388388

389389
* * *
390390

391391
### Quick Tip (Align The Repo Cards)
392392

393-
You usually won't be able to layout the images side by side. To do that you can use this approach:
393+
By default, GitHub does not lay out the cards side by side. To do that, you can use this approach:
394394

395395
```html
396396
<a href="https://github.com/anuraghazra/github-readme-stats">
@@ -405,7 +405,7 @@ You usually won't be able to layout the images side by side. To do that you can
405405

406406
#### [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
407407

408-
Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started!
408+
Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you do not have to worry about anything. Click on the deploy button to get started!
409409

410410
NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we should be able to handle more than 5k requests and have no issues with downtime :D
411411

@@ -436,7 +436,7 @@ NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we
436436

437437
## :sparkling_heart: Support the project
438438

439-
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
439+
I open-source almost everything I can and try to reply to everyone needing help using these projects. Obviously,
440440
this takes time. You can use this service for free.
441441

442442
However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:

0 commit comments

Comments
 (0)