Merge branch 'master' of https://github.com/vansh-codes/gityzer

vansh-codes · Oct 8, 2024 · 74b0386 · 74b0386
2 parents a049a20 + d28222b
commit 74b0386
Show file tree

Hide file tree

Showing 3 changed files with 155 additions and 56 deletions.
diff --git a/.github/workflows/add-contributors.yml b/.github/workflows/add-contributors.yml
@@ -0,0 +1,27 @@
+name: Update Contributors in README
+
+on:
+  push:
+    branches: ["master"]
+  workflow_dispatch:
+
+jobs:
+  contrib-readme-job:
+    runs-on: ubuntu-latest
+    name: A job to automate contrib in readme
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Update Contributors List
+        uses: akhilmhdh/[email protected]
+        with:
+          commit_message: "Updated contributors list"
+          committer_username: "vansh-codes"
+          committer_email: "[email protected]"
+          readme_path: "CONTRIBUTORS.md"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -0,0 +1,70 @@
+## Contributors
+We are immensely grateful to the following amazing individuals who have contributed their time, effort, and expertise to make this project better. Your contributions, whether through code, documentation, bug reports, or feature suggestions, have been invaluable. Thank you for helping us build and improve GITYZER 🌟✨
+
+Your dedication and hard work are what drive this project forward, and we couldn't have done it without you. Each contribution, no matter how small, plays a crucial role in our journey towards creating a more efficient and user-friendly tool for developers. 🙌💻
+
+We look forward to your continued support and collaboration. Together, we can achieve even greater heights! 🚀🌐
+
+Thank you once again to all our contributors! Your efforts are truly appreciated. 💖👏
+
+<!-- readme: contributors -start -->
+<table>
+	<tbody>
+		<tr>
+            <td align="center">
+                <a href="https://github.com/vansh-codes">
+                    <img src="https://avatars.githubusercontent.com/u/114163734?v=4" width="100;" alt="vansh-codes"/>
+                    <br />
+                    <sub><b>Vansh Chaurasiya</b></sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/yashksaini-coder">
+                    <img src="https://avatars.githubusercontent.com/u/115717039?v=4" width="100;" alt="yashksaini-coder"/>
+                    <br />
+                    <sub><b>Yash Kumar Saini</b></sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/Tamanna225">
+                    <img src="https://avatars.githubusercontent.com/u/119917783?v=4" width="100;" alt="Tamanna225"/>
+                    <br />
+                    <sub><b>Tamanna</b></sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/HarshitShukla-dev">
+                    <img src="https://avatars.githubusercontent.com/u/109151752?v=4" width="100;" alt="HarshitShukla-dev"/>
+                    <br />
+                    <sub><b>Harshit Shukla</b></sub>
+                </a>
+            </td>
+            <td align="center">
+                <a href="https://github.com/adityakalburgi">
+                    <img src="https://avatars.githubusercontent.com/u/124163311?v=4" width="100;" alt="adityakalburgi"/>
+                    <br />
+                    <sub><b>Aditya kalburgi</b></sub>
+                </a>
+            </td>
+		</tr>
+	<tbody>
+</table>
+<!-- readme: contributors -end -->
+
+<br>
+
+### &#8627; Stargazers
+
+<div align='center'>
+
+[![Stargazers repo roster for @vansh-codes/Gityzer](https://reporoster.com/stars/vansh-codes/Gityzer)](https://github.com/vansh-codes/Gityzer/stargazers)
+
+</div>
+
+### &#8627; Forkers
+<div align='center'>
+
+[![Forkers repo roster for @vansh-codes/Gityzer](https://reporoster.com/forks/vansh-codes/Gityzer)](https://github.com/vansh-codes/Gityzer/network/members)
+
+</div>
+
diff --git a/README.md b/README.md
@@ -1,22 +1,37 @@
-<h1 align="center">GITYZER</h1>
-
-## Gityzer is an open-source tool that generates a personalized image summarizing a user's GitHub stats. This image can be easily embedded in GitHub README files, helping developers showcase their contributions, coding activity, and overall GitHub presence.
+<div align="center">
 
-<p align="center">
+# **GITYZER**
 
-<a href="https://github.com/vansh-codes/Gityzer"><img src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103"></a> <a href="https://github.com/vansh-codes/Gityzer/blob/master/LICENSE"><img src="https://img.shields.io/badge/MIT-Licence-blue.svg?v=103"></a> 
+<i>Gityzer is an open-source tool that generates a personalized image summarizing a user's GitHub stats. This image can be easily embedded in GitHub README files, helping developers showcase their contributions, coding activity, and overall GitHub presence.*
+</i>
 
-![GitHub issues](https://img.shields.io/github/issues/vansh-codes/Gityzer)
-![GitHub pull requests](https://img.shields.io/github/issues-pr/vansh-codes/Gityzer)
-![GitHub forks](https://img.shields.io/github/forks/vansh-codes/Gityzer)
-![GitHub Repo stars](https://img.shields.io/github/stars/vansh-codes/Gityzer?style=social)
-![GitHub contributors](https://img.shields.io/github/contributors/vansh-codes/Gityzer)
-<br/>
-![Repo Size](https://img.shields.io/github/repo-size/vansh-codes/Gityzer)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github?af=5236ad)
-<br/>
-![Visitors Count](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Fvansh-codes%2FGityzer&label=visitors&countColor=%2337d67a&style=flat&labelStyle=upper)
-</p>
+<br>
+<table align="center">
+  <thead align="center">
+    <tr border="1">
+      <th>🤖 Project</th>
+      <th>🌟 Stars</th>
+      <th>🍴 Forks</th>
+      <th>🐛 Issues</th>
+      <th>🔔 Open PRs</th>
+      <th>🔕 Close PRs</th>
+      <th>👥 Contributors</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><img src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103"></td>
+      <td><img src="https://img.shields.io/github/stars/vansh-codes/Gityzer?style=social"></td>
+      <td><img src="https://img.shields.io/github/forks/vansh-codes/Gityzer"></td>
+      <td><img src="https://img.shields.io/github/issues/vansh-codes/Gityzer"></td>
+      <td><img src="https://img.shields.io/github/issues-pr/vansh-codes/Gityzer"></td>
+      <td><img src="https://img.shields.io/github/issues-pr-closed/vansh-codes/Gityzer?color=critical"></td>
+      <td><img src="https://img.shields.io/github/contributors/vansh-codes/Gityzer?color=blue"></td>
+    </tr>
+  </tbody>
+</table>
+</div>
+<br>
 
 ## <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/People%20with%20professions/Man%20Technologist%20Medium%20Skin%20Tone.png" alt="man-techno" height=50 width=50> Live Demo
 Visit https://gityzer.vercel.app/ to see the live demo
@@ -62,30 +77,38 @@ Gityzer is proudly part of global initiatives engaging with passionate developer
   </a>
 </p>
 
-### How it works ?
-1. Fetch GitHub Data: Gityzer collects details about a user's GitHub profile, such as:
-   - Total contributions
-   - Participation in repositories
-   - Active coding days
-   - Most used programming languages
-   - and many more parameters..
+### How it works
+
+1. **Fetch GitHub Data:** Gityzer collects details about a user's GitHub profile, such as:
+  - Total contributions
+  - Participation in repositories
+  - Active coding days
+  - Most used programming languages
+  - And many more parameters
+
 2. **Generate a Custom Tagline:** Using AI (the Gemini model), Gityzer creates a unique tagline for each user based on their activity and contribution patterns on GitHub. This tagline is consistent and meaningful, providing an at-a-glance summary of the user's work.
+
 3. **Create and Embed an Image:** The tool generates an image with the following customizable elements:
-    - **Username**: Details fetched from the GitHub profile.
-    - **Styling Options:** Users can choose from different styles, themes (like dark or light mode), and color combinations.
-    - **Update Frequency:** Users can decide how often the image gets updated (e.g., every 14 days). 
+   - **Username:** Details fetched from the GitHub profile.
+   - **Styling Options:** Users can choose from different styles, themes (like dark or light mode), and color combinations.
+   - **Update Frequency:** Users can decide how often the image gets updated (e.g., every 14 days).
+
 4. **Avoid Rate Limits:** To prevent hitting GitHub’s API rate limits, users will need to provide their *GitHub personal access token* with read permissions. This allows them to fetch their own profile data more efficiently.
 
-Example URL:
+**Example URL:**
+
 Users can generate and customize the image using a URL like:
+
 ```css
 gityzer.vercel.app?<github_username>&update=14&style=dark&theme=dark&color=white
 ```
-- <github_username>: The GitHub username.
-- update=14: Update the image every 14 days. optional parameter, by default set to 14
-- style=dark: Choose the style (e.g., dark).
-- theme=dark: Set the theme (e.g., dark mode).
-- color=white: Choose the text color (e.g., white).
+
+- `<github_username>`: The GitHub username.
+- `update=14`: Update the image every 14 days (optional parameter, default is 14).
+- `style=dark`: Choose the style (e.g., dark).
+- `theme=dark`: Set the theme (e.g., dark mode).
+- `color=white`: Choose the text color (e.g., white).
+
 
 ## How to contribute ?
 
@@ -143,29 +166,8 @@ This project and everyone participating in it is governed by the [Code of Conduc
 </div>
 <br>
 
-- We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating Gityzer to greater heights.
-- Make sure you show some love by giving ⭐ to our repository
-
-<br>
-
-<!-- <center>
-<div>
-<a href="https://github.com/vansh-codes/Gityzer/graphs/contributors">
-  <img width="90%" src="https://contrib.rocks/image?repo=vansh-codes/Gityzer" />
-</a>
-</div>
-</center>
- -->
-## License 📝
-
-<img src="https://img.shields.io/badge/License-MIT-yellow.svg"/> <br> 
-Gityzer is licensed under the terms of the MIT License. check out <a href="./LICENSE">LICENSE</a> for details. <img width=2300/>
-
-<a name="support"></a>
-
-## Support ⭐
+We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating Gityzer to greater heights. 
 
-- 💰 Become our [Sponsor](https://github.com/sponsors/vansh-codes)!
-- ⭐ Star our Repo 
+Here are the wonderful people who have contributed in [Gityzer](https://github.com/vansh-codes/Gityzer). You can see them here [CONTRIBUTORS.md](CONTRIBUTORS.md)
+Make sure you show some love by giving ⭐ to our repository
 
-<p align="right">(<a href="#top">Back to top⬆️</a>)</p>