Skip to content

Commit 67bf778

Browse files
authored
docs: Update Readme (#20)
* Added some features and contribute section added new features to the about project in the file. changed the alignment.. Also added about how to contribute in this project. Last added support section as well * added diff contributing way Earlier was some causing issue changed it. * Final changes
1 parent f634122 commit 67bf778

File tree

1 file changed

+49
-2
lines changed

1 file changed

+49
-2
lines changed

README.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,20 @@
1212

1313
## Features
1414
- **GitHub Profile Visualization:** GitGlance provides a comprehensive visualization of a developer's GitHub profile, including their contributions, repositories, and more.
15+
1516
- **Field of Contributions:** Understand the areas in which the developer contributes the most through a graphical representation.
17+
1618
- **GitHub GraphQL API Integration:** Utilizing the GitHub GraphQL API, GitGlance fetches user data directly from GitHub, ensuring accurate and up-to-date information.
19+
1720
- **Next.js & Tailwind CSS:** Built with Next.js for efficient server-side rendering and Tailwind CSS for easy styling and customization.
21+
1822
- **Responsive Design:** GitGlance is designed to be responsive, ensuring a seamless experience across various devices and screen sizes.
1923

24+
- **Responsive Design for Any Device:** GitGlance is meticulously crafted to adapt to various devices and screen sizes, ensuring a consistent and user-friendly experience across desktops, tablets, and smartphones.
25+
26+
- **Dynamic Chart Generation:** GitGlance employs advanced chart generation techniques to dynamically visualize GitHub data. Whether it's plotting commit timelines, repository language distributions, or pull request statistics, GitGlance generates interactive and customizable charts.
27+
28+
2029
## Screenshots
2130

2231
<!-- <img > -->
@@ -62,14 +71,52 @@ To run GitGlance locally, follow these steps:
6271
## Contributing
6372
Contributions are welcome! If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.
6473

74+
75+
## How to Contribute
76+
We welcome contributions from the community to enhance GitGlance further.You can use GitHub Desktop to manage this repository. Here's how:
77+
78+
1. **Download and Install GitHub Desktop**:
79+
- Go to the [GitHub Desktop website](https://desktop.github.com/) and download the GitHub Desktop application.
80+
- Follow the installation instructions to install GitHub Desktop on your computer.
81+
82+
2. **Clone the Repository**:
83+
- Open GitHub Desktop and sign in to your GitHub account.
84+
- Click on the "File" menu, then select "Clone Repository..."
85+
- Choose the repository you want to clone from the list or enter its URL.
86+
- Choose the local path where you want to clone the repository and click "Clone".
87+
88+
3. **Make Changes**:
89+
- After cloning the repository, you can make changes to the files locally using your preferred code editor.
90+
91+
4. **Commit Changes**:
92+
- Once you've made changes, open GitHub Desktop.
93+
- You'll see a list of files with changes. Write a summary and description of your changes in the text fields.
94+
- Click "Commit to main" to commit your changes locally.
95+
96+
5. **Push Changes**:
97+
- To push your changes to the remote repository on GitHub.com, click "Push origin".
98+
99+
6. **Pull Changes**:
100+
- If there are changes on the remote repository that you don't have locally, you can pull them by clicking "Fetch origin" or "Pull origin".
101+
102+
7. **Sync Changes**:
103+
- To synchronize your local repository with the remote repository, click "Sync" to push and pull changes in one step.
104+
105+
That's it! You can now use GitHub Desktop to manage this repository efficiently.
106+
65107
## License
66108
This project is licensed under the MIT License. see the LICENSE file for details.
67109
68-
## Acknowledgements
69110
111+
## Acknowledgements
70112
GitGlance utilizes the following technologies and libraries:
71113
72114
- [Next.js](https://nextjs.org/)
73115
- [Tailwind CSS](https://tailwindcss.com/)
74116
- [GitHub GraphQL API](https://docs.github.com/en/graphql)
75-
- [Node.js](https://nodejs.org/)
117+
- [Node.js](https://nodejs.org/)
118+
119+
120+
## Support
121+
122+
This project needs a ⭐️ from you. Don't forget to leave a star ⭐️

0 commit comments

Comments
 (0)