GitHub Readme Generator Chrome Extension

A Chrome extension built using Vite and React that automates the generation of GitHub README.md files. It leverages the power of Google Gemini AI to analyze a repository's structure, content, and files, and generates a professional and detailed README.md file.

Index

• Features
• Installation
• How to use?
• Technologies Used
• Project Media
• Contribution
• License

Features

• Automated README Generation: Quickly create well-structured README files.
• Customizable Sections: Include sections such as Installation, Usage, Contributing, and more.
• Live Preview: View the README as you build it.
• Easy Integration: Seamlessly integrates with your GitHub repositories.

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/github-readme-generator-chrome-extension.git

2. Navigate to the project directory:

   cd github-readme-generator-chrome-extension

3. Install dependencies:

   npm install

4. Build the project:

   npm run build

5. Load the extension:
   • Open Chrome and navigate to chrome://extensions/.
   • Enable "Developer mode" in the top right corner.
   • Click "Load unpacked" and select the dist folder.

How to use?

1. Navigate to a GitHub repository in Chrome.
2. Click the GitHub Readme Generator extension icon.
3. Provide Gemini Api key and GitHub Access Token.
4. The extension will analyze the repository's files and folder structure.
5. Review the generated README.md file.
6. Click on update/create your repository's README.md file.

Technologies Used

• React: For building the user interface.
• Vite: For fast and efficient development and build processes.
• Google Gemini AI: For AI-powered content analysis and generation.
• Chrome APIs: To integrate and manage the extension's behavior within the Chrome browser.
• GitHub APIs: These are used to fetch repository data and automate README generation.

Contribution

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a feature branch:

   git checkout -b feature-name

3. Commit your changes:

   git commit -m "Add feature-name"

4. Push to the branch:

   git push origin feature-name

5. Open a pull request.

Project Media

License

This project is licensed under the MIT License. See the LICENSE file for details.

🧑‍💻 Happy coding!