78 lines
4.9 KiB
Markdown
78 lines
4.9 KiB
Markdown
<div align="center">
|
|
<img src="docs/appIcon.svg" width="100px" alt="GitHub Stats Extended Logo" />
|
|
<h1>GitHub Stats Extended</h1>
|
|
<p>Dynamically generate GitHub stats for your READMEs.</p>
|
|
<a href="https://github-stats-extended.vercel.app/api?username=anuraghazra"><img src="https://github-stats-extended.vercel.app/api?username=anuraghazra"></a>
|
|
</div>
|
|
|
|
This project is the [extended, actively maintained successor](docs/fork.md) of [github-readme-stats](https://github.com/anuraghazra/github-readme-stats). It generates [various stats cards](#card-types), e.g. about your GitHub contributions, your top languages, etc. You can [customize](#advanced-customization) the cards via multiple parameters.
|
|
|
|
# Table of Contents
|
|
- [Quick Start](#quick-start)
|
|
- [Migration from github-readme-stats](#migration-from-github-readme-stats)
|
|
- [Card Types](#card-types)
|
|
- [Advanced Customization](#advanced-customization)
|
|
- [Run It Yourself](#run-it-yourself)
|
|
- [Acknowledgements](#acknowledgements)
|
|
- [Contributing](#contributing)
|
|
|
|
# Quick Start
|
|
- Copy and paste this into your markdown:
|
|
```markdown
|
|
[](https://github.com/stats-organization/github-stats-extended)
|
|
```
|
|
- Change the `?username=` value to your GitHub username.
|
|
- Done!
|
|
|
|
-----------------------
|
|
|
|
As more comfortable alternative, use the [GitHub-Stats-Extended Wizard](https://github-stats-extended.vercel.app/frontend) to create your custom stats card. Copy the generated markdown code and paste it into your [GitHub profile README](https://docs.github.com/en/account-and-profile/how-tos/profile-customization/managing-your-profile-readme#adding-a-profile-readme). Done!
|
|
|
|
# Migration from github-readme-stats
|
|
To migrate from [github-readme-stats](https://github.com/anuraghazra/github-readme-stats) you only need to change the domain from `github-readme-stats.vercel.app` to `github-stats-extended.vercel.app`:
|
|
|
|
```diff
|
|
- https://github-readme-stats.vercel.app/api?username=octocat&theme=radical
|
|
+ https://github-stats-extended.vercel.app/api?username=octocat&theme=radical
|
|
```
|
|
|
|
GitHub-Stats-Extended aims to be fully compatible with github-readme-stats. For more details see [Compatibility Notes](docs/fork.md#compatibility-notes).
|
|
|
|
# Card Types
|
|
- Show your GitHub statistics:
|
|
|
|
|
|
|
|
- ...your top languages...:
|
|
|
|
|
|
|
|
- ...and development time:
|
|
|
|
[](https://wakatime.com/@alan)
|
|
|
|
- Pin more than 6 repos in your GitHub profile:
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
- Pin Gists in your GitHub profile:
|
|
|
|
[](https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d)
|
|
|
|
- Customize all the cards:
|
|
|
|
[](https://github-stats-extended.vercel.app/api/?username=anuraghazra&show_icons=true&theme=calm&rank_icon=github&include_all_commits=true&custom_title=Anurag's+Stats&disable_animations=true&number_format=long&show=prs_merged_percentage,prs_reviewed)
|
|
|
|
# Advanced Customization
|
|
The [GitHub-Stats-Extended Wizard](https://github-stats-extended.vercel.app/frontend) offers some essential customization options. For more advanced customization check out the [advanced documentation](docs/advanced_documentation.md).
|
|
|
|
# Run It Yourself
|
|
If you want to run GitHub-Stats-Extended on your own, there are two main deployment options: you can use [github-readme-stats-action](https://github.com/stats-organization/github-readme-stats-action) to generate cards in your own GitHub Actions workflow. Or you can self-host GitHub-Stats-Extended on Vercel.
|
|
|
|
See [Run It Yourself](docs/deploy.md) for detailed instructions.
|
|
|
|
# Acknowledgements
|
|
This project is based on [github-readme-stats](https://github.com/anuraghazra/github-readme-stats). On top of that project's functionality GitHub-Stats-Extended adds several new features and improvements. See [Fork Information](docs/fork.md) for a list of changes. The frontend added to GitHub-Stats-Extended is based on [GitHub Trends](https://github.com/avgupta456/github-trends). Big thanks to [@anuraghazra](https://github.com/anuraghazra), [@avgupta456](https://github.com/avgupta456), [@rickstaa](https://github.com/rickstaa), [@qwerty541](https://github.com/qwerty541) and everyone else who worked on these projects! ❤️
|
|
|
|
# Contributing
|
|
Contributions are welcome! |