DEV Community

Cover image for Check out this new Repository!
Wint Khant Lin
Wint Khant Lin

Posted on

Check out this new Repository!

If you're looking to make your GitHub README files more engaging and informative, look no further! With the Cool GitHub README API, you can easily enhance your README with dynamic and eye-catching elements. 🌟

What Is Cool GitHub README API?

The Cool GitHub README API is a powerful tool designed to help you generate beautiful and interactive README sections for your GitHub projects. Whether you want to showcase real-time data or simply add a touch of style, this API is your go-to solution.

Currently Available Widgets

1. Streaks

Show off your contribution streaks with a customizable image:

  • URL: https://cool-github-readme-api.vercel.app/streak/<username>?theme=light&size=100
  • Markdown Example:

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

    • <username>: Replace with your GitHub username.
    • theme: Choose between light (default) or dark.
    • size: Adjust the image size (default is 250).

2. Release Download Count

Highlight the download count of your repository with a sleek card:

  • URL: https://cool-github-readme-api.vercel.app/total-downloads/<username>/<repo>?theme=light&border=#fff
  • Markdown Example:

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

    • <username>: Replace with your GitHub username.
    • <repo>: Replace with your repository name.
    • theme: Choose between light (default) or dark.
    • border: Customize the border color (default is #797067).

Image description

Conclusion

The Cool GitHub README API is a fantastic way to make your GitHub profile stand out. With customizable streaks and download count cards, you can add a professional and personal touch to your project pages. Give it a try and let your README shine! 🌟

Top comments (0)