diff --git a/README.md b/README.md index 49f2a69..940fdf5 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,20 @@ ## Features - **GitHub Profile Visualization:** GitGlance provides a comprehensive visualization of a developer's GitHub profile, including their contributions, repositories, and more. + - **Field of Contributions:** Understand the areas in which the developer contributes the most through a graphical representation. + - **GitHub GraphQL API Integration:** Utilizing the GitHub GraphQL API, GitGlance fetches user data directly from GitHub, ensuring accurate and up-to-date information. + - **Next.js & Tailwind CSS:** Built with Next.js for efficient server-side rendering and Tailwind CSS for easy styling and customization. + - **Responsive Design:** GitGlance is designed to be responsive, ensuring a seamless experience across various devices and screen sizes. +- **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. + +- **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. + + ## Screenshots @@ -62,14 +71,52 @@ To run GitGlance locally, follow these steps: ## Contributing 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. + +## How to Contribute +We welcome contributions from the community to enhance GitGlance further.You can use GitHub Desktop to manage this repository. Here's how: + +1. **Download and Install GitHub Desktop**: + - Go to the [GitHub Desktop website](https://desktop.github.com/) and download the GitHub Desktop application. + - Follow the installation instructions to install GitHub Desktop on your computer. + +2. **Clone the Repository**: + - Open GitHub Desktop and sign in to your GitHub account. + - Click on the "File" menu, then select "Clone Repository..." + - Choose the repository you want to clone from the list or enter its URL. + - Choose the local path where you want to clone the repository and click "Clone". + +3. **Make Changes**: + - After cloning the repository, you can make changes to the files locally using your preferred code editor. + +4. **Commit Changes**: + - Once you've made changes, open GitHub Desktop. + - You'll see a list of files with changes. Write a summary and description of your changes in the text fields. + - Click "Commit to main" to commit your changes locally. + +5. **Push Changes**: + - To push your changes to the remote repository on GitHub.com, click "Push origin". + +6. **Pull Changes**: + - 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". + +7. **Sync Changes**: + - To synchronize your local repository with the remote repository, click "Sync" to push and pull changes in one step. + +That's it! You can now use GitHub Desktop to manage this repository efficiently. + ## License This project is licensed under the MIT License. see the LICENSE file for details. -## Acknowledgements +## Acknowledgements GitGlance utilizes the following technologies and libraries: - [Next.js](https://nextjs.org/) - [Tailwind CSS](https://tailwindcss.com/) - [GitHub GraphQL API](https://docs.github.com/en/graphql) -- [Node.js](https://nodejs.org/) \ No newline at end of file +- [Node.js](https://nodejs.org/) + + +## Support + +This project needs a ⭐️ from you. Don't forget to leave a star ⭐️ \ No newline at end of file