Skip to content

Commit

Permalink
[docs] Add Support paragraph in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HwangTaehyun committed Jan 22, 2023
1 parent ff309e3 commit 3636e07
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 15 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
<p align="center">
<img width="100px" src="https://res.cloudinary.com/anuraghazra/image/upload/v1594908242/logo_ccswme.svg" align="center" alt="GitHub Readme Stats" />
<h2 align="center">GitHub Contributor Stats</h2>
<p align="center">Get dynamically generated your github contributor stats on your READMEs!</p>
<h2 align="center">GitHub Repository Contribution Stats</h2>
<p align="center">Get dynamically generated your github repository contribution stats on your READMEs!</p>
</p>

# Features

- [GitHub Contributor Stats Card](#github-contributor-stats-card)
- [GitHub Repository Contribution Stats Card](#github-repository-contribution-stats-card)
- [Themes](#themes)

# GitHub Contributor Stats Card
# GitHub Repository Contribution Stats Card

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

My project, which is based on [github-readme-stats](https://github.com/anuraghazra/github-readme-stats), focuses on showing GitHub contributor stats and applies the typescript to the original project. Refer to [ISSUE#2027](https://github.com/anuraghazra/github-readme-stats/issues/2027). Thank you [@anuraghazra](https://github.com/anuraghazra) for the awesome open-source project!
My project, which is based on [github-readme-stats](https://github.com/anuraghazra/github-readme-stats), focuses on showing GitHub repository contribution stats and applies the typescript to the original project. Refer to [ISSUE#2027](https://github.com/anuraghazra/github-readme-stats/issues/2027). Thank you [@anuraghazra](https://github.com/anuraghazra) for the awesome open-source project!

Change the `?username=` value to your GitHub username.

```md
![Taehyun's GitHub Contributor stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun)
![Taehyun's GitHub Repository Contribution stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun)
```

### Demo

![Taehyun's GitHub Contributor stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun&hide=B)
![Taehyun's GitHub Repository Contribution stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun&hide=B)

\_Note: Available ranks are S+ (over 10000), S (over 1000), A+ (over 500), A (over 100), B+ (over 50) and B (over 1).

Expand All @@ -32,7 +32,7 @@ Change the `?username=` value to your GitHub username.
To hide specific ranks, you can pass a query parameter `&hide=` with comma-separated rank values. If you need to add plus rank (ex. B+) to hide arrays , it is always safe to replace pluses with %2B

```md
![Taehyun's GitHub Contributor stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun&hide=B,B%2B)
![Taehyun's GitHub Repository Contribution stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun&hide=B,B%2B)
```

### Themes
Expand All @@ -42,7 +42,7 @@ With inbuilt themes, you can customize the look of the card without doing any [m
Use `&theme=THEME_NAME` parameter like so :-

```md
![Taehyun's GitHub Contributor stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun&hide=B&theme=default)
![Taehyun's GitHub Repository Contribution stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun&hide=B&theme=default)
```

#### All inbuilt themes:- in <a href="https://github.com/anuraghazra/github-readme-stats">github-readme-stats' themes</a>
Expand All @@ -56,3 +56,7 @@ You can look at a preview for [all available themes](./themes/README.md) or chec
Contributions are welcome!

Made with :fire: and TypeScript.

## 🙋‍♂️ Support

❤️ If you like this project, give it a ⭐ and share it with friends!
7 changes: 4 additions & 3 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -25694,10 +25694,11 @@ const createTextNode = ({ imageBase64, name, rank, index, height }) => {
<text class="stat bold">${name}</text>
</g>
<g data-testid="rank-circle" transform="translate(${offset}, 0)">
<circle class="rank-circle-rim" cx="12.5" cy="12.5" r="14" />
<g class="rank-text">
<circle class="rank-circle-rim" cx="12.5" cy="12.5" r="14">
<g class="rank-text">
${rankText}
</g>
</g>
</circle>
</g>
</g>
`;
Expand Down
7 changes: 4 additions & 3 deletions src/cards/stats-card.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,11 @@ const createTextNode = ({ imageBase64, name, rank, index, height }) => {
<text class="stat bold">${name}</text>
</g>
<g data-testid="rank-circle" transform="translate(${offset}, 0)">
<circle class="rank-circle-rim" cx="12.5" cy="12.5" r="14" />
<g class="rank-text">
<circle class="rank-circle-rim" cx="12.5" cy="12.5" r="14">
<g class="rank-text">
${rankText}
</g>
</g>
</circle>
</g>
</g>
`;
Expand Down

1 comment on commit 3636e07

@vercel
Copy link

@vercel vercel bot commented on 3636e07 Jan 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.