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

chore: added Github Extra Pin docs (#8)

Browse Source 
* docs: added Github Extra pins docs

* docs: alignment tip

* chore: docs update
This commit is contained in:
Anurag Hazra 2020-07-09 22:56:57 +05:30 committed by GitHub
parent 08027eff60
commit d0630feebc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
readme.md
View File

@ -2,7 +2,12 @@
Get dynamically generated github stats on your readmes!
## How to use
# Features
- [Github Stats Card](#github-stats-card)
- [Github Extra Pins](#github-extra-pins)
# Github Stats Card
Copy paste this into your markdown content and thats it. simple!
@ -35,7 +40,7 @@ Other options:
- `&hide_border=true` hide the border box if you don't like it :D.
- `&line_height=30` control the line-height between text.
## Demo
### Demo
- Default
@ -49,6 +54,39 @@ Other options:
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true)
# Github Extra Pins
Github extra pins allows you to pin more than 6 repositories in your profile by using github readme profile.
Yey! you are no longer limited to 6 pinned repos
### Usage
Copy paste this code into your readme and change the links.
Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats`
```md
[![ReadMe Card](https://github-readme-stats.anuraghazra1.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats)](https://github.com/anuraghazra/github-readme-stats)
```
### Demo
[![ReadMe Card](https://github-readme-stats.anuraghazra1.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats)](https://github.com/anuraghazra/github-readme-stats)
### 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
```md
<a href="https://github.com/anuraghazra/github-readme-stats">
<img align="left" src="https://github-readme-stats.anuraghazra1.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
<img align="left" src="https://github-readme-stats.anuraghazra1.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
</a>
```
Contributions are welcomed! <3
Made with :heart: and javascript.