GitHub Stats Me

A python script to update your readme file with stats from your GitHub account.
Report a bug or request a feature

Table of Contents

• Installation
  • Preparation work
  • Project setup
• Example
• Contributing
• License

---

Installation

Preparation work

Add comments to the place where you want to update in your readme file.

You can add your GitHub stats with:

<!-- github-stats-box start -->
<!-- github-stats-box end -->

You can add your most used languages stats with:

<!-- language-stats-box start -->
<!-- language-stats-box end -->

Project setup

For updating your github profile README, you can follow update-github-stats.yml to create a GitHub Action in your README repository.

Example

Here is an example from my own profile that you could obtain:

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature)
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNU General Public License v3.0. See LICENSE for more information.