An open API service indexing awesome lists of open source software.

https://github.com/happer64bit/cool-github-readme-api

🎨 Colorful GitHub README Stats API ⚡
https://github.com/happer64bit/cool-github-readme-api

api readme readme-stats ui

Last synced: about 1 year ago
JSON representation

🎨 Colorful GitHub README Stats API ⚡

Awesome Lists containing this project

README

          

# Cool GitHub README api

Create stunning and dynamic GitHub README files with ease! ✨

## 🚀 Overview

The Cool GitHub README API allows you to generate beautiful, informative, and engaging README files for your GitHub projects. Whether you're looking to display real-time data or simply make your README stand out, this API has got you covered.

## streak

* You can customize by `https://cool-github-readme-api.vercel.app/streak/?theme=light&size=100`

```markdown
![My Steaks](https://cool-github-readme-api.vercel.app/streak/?theme=light&size=200?border=black)
```

* Replace `` with your GitHub username.

* `theme (dark default)` - light and dark is avaliable
* `size` - Adjust the size of the image. The default is `250`.

| Light | Dark |
| ---|---|
| ![img](https://cool-github-readme-api.vercel.app/streak/happer64bit?theme=light) | ![img](https://cool-github-readme-api.vercel.app/streak/happer64bit) |

## Release Download Count

* You can customize by `https://cool-github-readme-api.vercel.app/steaks/?theme=light&size=100`

```markdown
![My Steaks](https://cool-github-readme-api.vercel.app/total-downloads/happer64bit/moviesharmal?theme=light&border=#fff)
```

* Replace `` with your GitHub username.
* Replace `` with your Repository.

* `theme (dark default)` - light and dark is avaliable
* `border (#797067 default)` - border for card

| Light | Dark |
| ---|---|
| ![img](https://cool-github-readme-api.vercel.app/total-downloads/happer64bit/moviesharmal?theme=light) | ![img](https://cool-github-readme-api.vercel.app/total-downloads/happer64bit/moviesharmal) |

## Stars

* You can customize by `https://cool-github-readme-api.vercel.app/stars/?theme=light&size=100`

```markdown
![My Stars](https://cool-github-readme-api.vercel.app/stars/?theme=light&size=200&border=black)
```

* Replace `` with your GitHub username.

* `theme (dark default)` - light and dark are available.
* `size` - Adjust the size of the image. The default is `250`.
* `border (#797067 default)` - Border color for the card.

| Light | Dark |
| ---|---|
| ![img](https://cool-github-readme-api.vercel.app/stars/happer64bit?theme=light) | ![img](https://cool-github-readme-api.vercel.app/stars/happer64bit) |

### Example Usage

Here's an example of how you can include the "Stars" widget in your README:

```markdown
![My Stars](https://cool-github-readme-api.vercel.app/stars/happer64bit?theme=light&size=200&border=black)
```