-
-
Get dynamically generated GitHub stats on your readmes!
+Get dynamically generated Code::Stats stats on your readmes!
-
-
- 
-
-
- 
-
-
- 
-
-
- 
-
-
- 
-
-
- View Demo - · - Report Bug - · - Request Feature -
-- Français - · - 简体中文 - · - Español - · - Deutsch - · - 日本語 - · - Português Brasileiro - · - Italiano - · - 한국어 -
- -Loved the project? Please consider donating to help it improve!
# Features
-- [GitHub Stats Card](#github-stats-card)
-- [GitHub Extra Pins](#github-extra-pins)
- [Top Languages Card](#top-languages-card)
- [Themes](#themes)
- [Customization](#customization)
@@ -69,39 +18,7 @@ Copy paste this into your markdown content, and that's it. Simple!
Change the `?username=` value to your GitHub's username.
```md
-[](https://github.com/anuraghazra/github-readme-stats)
-```
-
-_Note: Ranks are calculated based on user's stats, see [src/calculateRank.js](./src/calculateRank.js)_
-
-### Hiding individual stats
-
-To hide any specific stats, you can pass a query parameter `?hide=` with comma separated values.
-
-> Options: `&hide=stars,commits,prs,issues,contribs`
-
-```md
-
-```
-
-### Adding private contributions count to total commits count
-
-You can add the count of all your private contributions to the total commits count by using the query parameter `?count_private=true`.
-
-_Note: If you are deploying this project yourself, the private contributions will be counted by default otherwise you need to chose to share your private contribution counts._
-
-> Options: `&count_private=true`
-
-```md
-
-```
-
-### Showing icons
-
-To enable icons, you can pass `show_icons=true` in the query param, like so:
-
-```md
-
+[](https://github.com/Aviortheking/codestats-readme)
```
### Themes
@@ -111,7 +28,7 @@ With inbuilt themes you can customize the look of the card without doing any [ma
Use `?theme=THEME_NAME` parameter like so :-
```md
-
+
```
#### All inbuilt themes :-
@@ -143,22 +60,6 @@ You can provide multiple comma separated values in bg_color option to render a g
&bg_color=DEG,COLOR1,COLRO2,COLOR3...COLOR10
```
-> Note on cache: Repo cards have default cache of 4hours (14400 seconds) if the fork count & star count is less than 1k otherwise it's 2hours (7200). Also note that cache is clamped to a minimum of 2hours and maximum of 24hours
-
-#### Stats Card Exclusive Options:
-
-- `hide` - Hides the specified items from stats _(Comma seperated values)_
-- `hide_title` - _(boolean)_
-- `hide_rank` - _(boolean)_
-- `show_icons` - _(boolean)_
-- `include_all_commits` - Count total commits instead of just the current year commits _(boolean)_
-- `count_private` - Count private commits _(boolean)_
-- `line_height` - Sets the line-height between text _(number)_
-
-#### Repo Card Exclusive Options:
-
-- `show_owner` - Show the owner name of the repo _(boolean)_
-
#### Language Card Exclusive Options:
- `hide` - Hide the languages specified from the card _(Comma separated values)_
@@ -172,35 +73,11 @@ You can provide multiple comma separated values in bg_color option to render a g
---
-# GitHub Extra Pins
-
-GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
-
-Yey! You are no longer limited to 6 pinned repositories.
-
-### Usage
-
-Copy-paste this code into your readme and change the links.
-
-Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats`
-
-```md
-[](https://github.com/anuraghazra/github-readme-stats)
-```
-
-### Demo
-
-[](https://github.com/anuraghazra/github-readme-stats)
-
-Use [show_owner](#customization) variable to include the repo's owner username
-
-[](https://github.com/anuraghazra/github-readme-stats)
-
# Top Languages Card
-Top languages card shows github user's top languages which have been mostly used.
+Top languages card shows github user's top languages.
-_NOTE: Top languages does not indicate my skill level or something like that, it's a github metric of which languages i have the most code on github, it's a new feature of github-readme-stats_
+_NOTE: Top languages does not indicate your skill level or something like that, it's a metric of which languages you have the coded the most._
### Usage
@@ -209,7 +86,7 @@ Copy-paste this code into your readme and change the links.
Endpoint: `api/top-langs?username=anuraghazra`
```md
-[](https://github.com/anuraghazra/github-readme-stats)
+[](https://github.com/aviortheking/codestats-readme)
```
### Hide individual languages
@@ -217,7 +94,7 @@ Endpoint: `api/top-langs?username=anuraghazra`
You can use `?hide=language1,language2` parameter to hide individual languages.
```md
-[](https://github.com/anuraghazra/github-readme-stats)
+[](https://github.com/aviortheking/codestats-readme)
```
### Compact Language Card Layout
@@ -225,58 +102,46 @@ You can use `?hide=language1,language2` parameter to hide individual languages.
You can use the `&layout=compact` option to change the card design.
```md
-[](https://github.com/anuraghazra/github-readme-stats)
+[](https://github.com/aviortheking/codestats-readme)
+```
+
+### Language Count
+
+You can change the default language count (5) using the `&language_count=10` option.
+
+```md
+[](https://github.com/aviortheking/codestats-readme)
```
### Demo
-[](https://github.com/anuraghazra/github-readme-stats)
+[](https://github.com/aviortheking/codestats-readme)
- Compact layout
-[](https://github.com/anuraghazra/github-readme-stats)
+[](https://github.com/aviortheking/codestats-readme)
---
### All Demos
-- Default
-
-
-
-- Hiding specific stats
-
-
-
-- Showing icons
-
-
-
-- Include All Commits
-
-
-
- Themes
Choose from any of the [default themes](#themes)
-
+
- Gradient
-
+
- Customizing stats card
-
-
-- Customizing repo card
-
-
+
- Top languages
-[](https://github.com/anuraghazra/github-readme-stats)
+[](https://github.com/aviortheking/codestats-readme)
---
@@ -285,19 +150,18 @@ Choose from any of the [default themes](#themes)
You usually won't be able to layout the images side by side. To do that you can use this approach:
```md
-
-
+
+
-
-
+
+
```
## Deploy on your own Vercel instance
-#### [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
-Since the GitHub API only allows 5k requests per hour, it is possible that my `https://github-readme-stats.vercel.app/api` could hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started!
+Since the GitHub API only allows 5k requests per hour, it is possible that my `https://codestats-readme.vercel.app/api` could hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started!
NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we should be able to handle more than 5k requests and have no issues with downtime :D
@@ -318,29 +182,16 @@ NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we
1. Select `Import Git Repository`
-1. Select root and keep everything as is, just add your environment variable named PAT_1 (as shown), which will contain a personal access token (PAT), which you can easily create [here](https://github.com/settings/tokens/new) (leave everything as is, just name it something, it can be anything you want)
+1. Select root and keep everything as is (leave everything as is, just name it something, it can be anything you want)
1. Click deploy, and you're good to go. See your domains to use the API!
-## :sparkling_heart: Support the project
-
-I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
-this takes time. You can use this service for free.
-
-However, if you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-
-
-- Giving proper credit when you use github-readme-stats on your readme, linking back to it :D
-- Starring and sharing the project :rocket:
-- [](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
-
-Thanks! :heart:
-
---
Contributions are welcomed! <3
-Made with :heart: and JavaScript.
+Made with :heart: and Typescript.