avior/codestats-readme
1
0
Fork 0
mirror of https://github.com/Aviortheking/codestats-readme.git synced 2025-04-22 10:42:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #16 from nombrekeff/patch-1

Browse Source 
docs: Some little grammar fixes and improvements.
This commit is contained in:
Anurag Hazra 2020-07-10 16:18:04 +05:30 committed by GitHub
commit 8d982d59c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
readme.md
View File

@ -1,6 +1,6 @@
## Github Readme stats ## Github Readme stats
Get dynamically generated github stats on your readmes! Get dynamically generated GitHub stats on your readmes!
# Features # Features
@ -9,7 +9,7 @@ Get dynamically generated github stats on your readmes!
# Github Stats Card # Github Stats Card
Copy paste this into your markdown content and thats it. simple! Copy paste this into your markdown content, and that's it. Simple!
change the `?username=` value to your GitHubs's username change the `?username=` value to your GitHubs's username
@ -17,9 +17,9 @@ change the `?username=` value to your GitHubs's username
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra) ![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)
``` ```
### Hiding certain stats ### Hiding individual stats
To hide any specific stats you can pass a query parameter `?hide=` with an array of items you wanna hide. To hide any specific stats, you can pass a query parameter `?hide=` with an array of items, you wanna hide.
> Options: `&hide=["stars","prs","issues","contribs"]` > Options: `&hide=["stars","prs","issues","contribs"]`
@ -29,7 +29,7 @@ To hide any specific stats you can pass a query parameter `?hide=` with an array
### Showing icons ### Showing icons
To enable icons you can pass `show_icons=true` in the query param like so To enable icons, you can pass `show_icons=true` in the query param like so
```md ```md
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true) ![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
@ -56,13 +56,13 @@ Other options:
# Github Extra Pins # Github Extra Pins
Github extra pins allows you to pin more than 6 repositories in your profile by using github readme profile. Github extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
Yey! you are no longer limited to 6 pinned repos Yey! you are no longer limited to 6 pinned repositories.
### Usage ### Usage
Copy paste this code into your readme and change the links. Copy-paste this code into your readme and change the links.
Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats` Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats`
@ -76,7 +76,7 @@ Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats`
### Quick Tip (Align The Repo Cards) ### Quick Tip (Align The Repo Cards)
Normally you won't be able to layout the images side by side to do that you can use this approach You usually won't be able to layout the images side by side to do that you can use this approach
```md ```md
<a href="https://github.com/anuraghazra/github-readme-stats"> <a href="https://github.com/anuraghazra/github-readme-stats">