Skip to content

Commit 24869a3

Browse files
authored
docs: fixed spelling and grammar errors in Readme (#465)
1 parent 23d2d23 commit 24869a3

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

readme.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464

6565
# GitHub Stats Card
6666

67-
Copy paste this into your markdown content, and that's it. Simple!
67+
Copy-paste this into your markdown content, and that's it. Simple!
6868

6969
Change the `?username=` value to your GitHub's username.
7070

@@ -76,7 +76,7 @@ _Note: Ranks are calculated based on user's stats, see [src/calculateRank.js](./
7676

7777
### Hiding individual stats
7878

79-
To hide any specific stats, you can pass a query parameter `?hide=` with comma separated values.
79+
To hide any specific stats, you can pass a query parameter `?hide=` with comma-separated values.
8080

8181
> Options: `&hide=stars,commits,prs,issues,contribs`
8282
@@ -106,7 +106,7 @@ To enable icons, you can pass `show_icons=true` in the query param, like so:
106106

107107
### Themes
108108

109-
With inbuilt themes you can customize the look of the card without doing any [manual customization](#customization).
109+
With inbuilt themes, you can customize the look of the card without doing any [manual customization](#customization).
110110

111111
Use `?theme=THEME_NAME` parameter like so :-
112112

@@ -137,17 +137,17 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
137137

138138
##### Gradient in bg_color
139139

140-
You can provide multiple comma separated values in bg_color option to render a gradient, the format of the gradient is :-
140+
You can provide multiple comma-separated values in bg_color option to render a gradient, the format of the gradient is :-
141141

142142
```
143143
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
144144
```
145145

146-
> Note on cache: Repo cards have default cache of 4hours (14400 seconds) if the fork count & star count is less than 1k otherwise it's 2hours (7200). Also note that cache is clamped to a minimum of 2hours and maximum of 24hours
146+
> 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
147147
148148
#### Stats Card Exclusive Options:
149149

150-
- `hide` - Hides the specified items from stats _(Comma seperated values)_
150+
- `hide` - Hides the specified items from stats _(Comma-separated values)_
151151
- `hide_title` - _(boolean)_
152152
- `hide_rank` - _(boolean)_
153153
- `show_icons` - _(boolean)_
@@ -161,7 +161,7 @@ You can provide multiple comma separated values in bg_color option to render a g
161161

162162
#### Language Card Exclusive Options:
163163

164-
- `hide` - Hide the languages specified from the card _(Comma separated values)_
164+
- `hide` - Hide the languages specified from the card _(Comma-separated values)_
165165
- `hide_title` - _(boolean)_
166166
- `layout` - Switch between two available layouts `default` & `compact`
167167
- `card_width` - Set the card's width manually _(number)_
@@ -177,7 +177,7 @@ You can provide multiple comma separated values in bg_color option to render a g
177177

178178
GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
179179

180-
Yey! You are no longer limited to 6 pinned repositories.
180+
Yay! You are no longer limited to 6 pinned repositories.
181181

182182
### Usage
183183

@@ -199,9 +199,9 @@ Use [show_owner](#customization) variable to include the repo's owner username
199199

200200
# Top Languages Card
201201

202-
Top languages card shows github user's top languages which have been mostly used.
202+
The top languages card shows a GitHub user's top languages which have used the most.
203203

204-
_NOTE: Top languages does not indicate my skill level or something like that, it's a github metric of which languages have the most code on github, it's a new feature of github-readme-stats_
204+
_NOTE: Top Languages does not indicate my skill level or anything like that, it's a GitHub metric of which languages have the most code on GitHub. It's a new feature of github-readme-stats._
205205

206206
### Usage
207207

@@ -306,7 +306,7 @@ You usually won't be able to layout the images side by side. To do that you can
306306

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

309-
Since the GitHub API only allows 5k requests per hour, it is possible that my `https://github-readme-stats.vercel.app/api` could 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!
309+
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!
310310

311311
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
312312

0 commit comments

Comments
 (0)