A brief description of what this project does and who it's for.
Readme Creator is a web-based application designed to help developers create professional and well-structured README files for their projects. The application provides a user-friendly interface with pre-designed templates for common README sections. Users can add, edit, and reorder sections, with a live markdown preview of the final output.
A key feature of this application is the integration with the Gemini AI. By providing a Google Generative AI API key, users can leverage the power of AI to optimize and enhance the content of their README, ensuring clarity and impact.
The application is built with React and Redux for state management, and uses Material-UI for some UI components.
To run this project locally, follow these steps:
- Clone the repository:
git clone https://github.com/zccott/readme-generator.git
- Navigate to the project directory:
cd readme-creator - Install the dependencies:
npm install
- Start the development server:
npm run dev
Once the application is running, you can:
- Add new sections to your README from a list of available templates.
- Click on a section to edit its content in the markdown editor.
- See a live preview of the generated README.
- Enter your Gemini API key and click the "Optimize with Gemini" button to have the AI improve your README content.
- Reset the README to its initial state.
- Thanks to the creators of React, Redux, and Material-UI for their amazing libraries.
No additional information at this time.
Contributions are always welcome! Please feel free to open an issue or submit a pull request.
This project is licensed under the MIT License.
- zccott
- rahul-aot
| Color | Hex |
|---|---|
| Example Color | |
| Example Color | |
| Example Color | |
| Example Color |