Skip to content

GitHub Contribution Calendar Widget v1.0.0

Choose a tag to compare

View all tags
@imananoosheh imananoosheh released this 05 Jan 19:33
· 26 commits to main since this release
v1.0.0
f243003
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Release Description:

Hello, open-source enthusiasts! 🚀

I'm thrilled to announce the first release of the GitHub Contribution Calendar Widget, version 1.0.0!

What's New:

  • GitHub Calendar Component: Visualize your GitHub contributions with an interactive and customizable calendar.
  • Easy Integration: Import the widget effortlessly into your web applications.
  • Customization Options: Tailor the appearance with theme colors and background settings.
  • Minified Version: For optimized performance, we've included a minified version (githubcalendarwidget.min.js).

How to Use:

  1. Include the widget script in your HTML:

    <script src="https://cdn.jsdelivr.net/gh/imananoosheh/github-contributions-fetch@latest/githubcalendarwidget.min.js" defer type="module"></script>

  2. Add the following HTML tag to your page, providing a GitHub username: (theme-color and background-color are optional)

    <div id="calendar-component" username="your-github-username" theme-color="#00ff00" background-color="#121212"></div>

  3. That's it! Your GitHub Contribution Calendar will be rendered on the page.

Release Notes:

This release marks a significant milestone, and I'm excited to see how you integrate the GitHub Contribution Calendar Widget into your projects. If you encounter any issues or have feedback, please open an issue on GitHub.

Call for Contributions:

🔍 Looking to the Future: The next big step for this project is transitioning from JavaScript to TypeScript. If you're passionate about improving the project and want to contribute, this is a fantastic opportunity to get involved!

How to Contribute:

  1. 🍴 Fork the repository.
  2. 🛠️ Convert existing JavaScript code to TypeScript.
  3. 📦 Create a pull request.

Your contributions are invaluable, and together, we can make the GitHub Contribution Calendar Widget even better!

Thank you for your support and happy coding! 🎉

Best regards,
Iman Anooshehpour

Assets 2
Loading