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
+22-22
Original file line number
Diff line number
Diff line change
@@ -68,9 +68,9 @@
68
68
<imgsrc="https://indiaspora.org/wp-content/uploads/2021/04/give-India-logo.png"alt="Give india logo"width="200" />
69
69
</a>
70
70
71
-
Are you considering supporting the project by donating? Please DON'T!!
71
+
Are you considering supporting the project by donating? Please DO NOT!!
72
72
73
-
Instead, Help India fight the 2nd deadly wave of COVID-19.
73
+
Instead, Help India fight the second deadly wave of COVID-19.
74
74
Thousands of people are dying in India because of a lack of Oxygen & also COVID-related infrastructure.
75
75
76
76
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
94
94
95
95
# GitHub Stats Card
96
96
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!
98
98
99
99
Change the `?username=` value to your GitHub username.
100
100
@@ -108,7 +108,7 @@ The implementation can be investigated at [src/calculateRank.js](./src/calculate
108
108
109
109
### Hiding individual stats
110
110
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.
@@ -120,7 +120,7 @@ To hide any specific stats, you can pass a query parameter `&hide=` with comma-s
120
120
121
121
You can add the count of all your private contributions to the total commits count by using the query parameter `&count_private=true`.
122
122
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)._
124
124
125
125
> Options: `&count_private=true`
126
126
@@ -148,15 +148,15 @@ Use `&theme=THEME_NAME` parameter like so :
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
156
156
157
157
### Customization
158
158
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.
160
160
161
161
#### Common Options
162
162
@@ -175,11 +175,11 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
175
175
176
176
##### Gradient in bg_color
177
177
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:
179
179
180
180
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
181
181
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.
183
183
184
184
#### Stats Card Exclusive Options
185
185
@@ -190,7 +190,7 @@ You can provide multiple comma-separated values in the bg_color option to render
190
190
-`show_icons` - _(boolean)_. Default: `false`.
191
191
-`include_all_commits` - Count total commits instead of just the current year commits _(boolean)_. Default: `false`.
-`custom_title` - Sets a custom title for the card. Default: `<username> Github Stats`.
196
196
-`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
205
205
206
206
#### Language Card Exclusive Options
207
207
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)`.
209
209
-`hide_title` - _(boolean)_. Default: `false`.
210
210
-`layout` - Switch between two available layouts `default` & `compact`. Default: `default`.
211
211
-`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
214
214
-`custom_title` - Sets a custom title for the card _(string)_. Default `Most Used Languages`.
215
215
216
216
> :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)
218
218
> (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use
219
219
> [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
220
220
221
221
#### Wakatime Card Exclusive Options
222
222
223
223
-`hide` - Hide the languages specified from the card _(Comma-separated values)_. Default: `[] (blank array)`.
224
224
-`hide_title` - _(boolean)_. Default `false`.
225
-
-`line_height` - Sets the line-height between text _(number)_. Default `25`.
225
+
-`line_height` - Sets the lineheight between text _(number)_. Default `25`.
226
226
-`hide_progress` - Hides the progress bar and percentage _(boolean)_. Default `false`.
227
227
-`custom_title` - Sets a custom title for the card _(string)_. Default `Wakatime Stats`.
228
228
-`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`.
231
231
-`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`.
232
232
233
233
* * *
234
234
235
235
# GitHub Extra Pins
236
236
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.
238
238
239
239
Yay! You are no longer limited to 6 pinned repositories.
240
240
@@ -260,7 +260,7 @@ Use [show_owner](#customization) variable to include the repo's owner username
260
260
261
261
The top languages card shows a GitHub user's most frequently used top language.
262
262
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._
@@ -405,7 +405,7 @@ You usually won't be able to layout the images side by side. To do that you can
405
405
406
406
#### [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
407
407
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!
409
409
410
410
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
411
411
@@ -436,7 +436,7 @@ NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we
436
436
437
437
## :sparkling_heart: Support the project
438
438
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,
440
440
this takes time. You can use this service for free.
441
441
442
442
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