Skip to content

Commit

Permalink
chore: added Github Extra Pin docs (anuraghazra#8)
Browse files Browse the repository at this point in the history
* docs: added Github Extra pins docs

* docs: alignment tip

* chore: docs update
  • Loading branch information
anuraghazra authored Jul 9, 2020
1 parent 08027ef commit d0630fe
Showing 1 changed file with 40 additions and 2 deletions.
42 changes: 40 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down Expand Up @@ -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

Expand All @@ -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.

0 comments on commit d0630fe

Please sign in to comment.