Readme Studio

Let AI do the writing. Readme Studio creates meaningful, professional READMEs tailored to your project and fully editable.

🚀 Features

• AI-powered README generation
• Markdown Editor
• Live markdown preview
• Pre-built README templates
• Dark mode support

🛠️ Tech Stack

• Vue.js
• TypeScript
• Vite
• Pinia (State Management)
• Vue Router
• TailwindCSS
• Marked (Markdown Processing)
• DOMPurify (Security)

📦 Installation

1. Clone the repository:

git clone [https://github.com/zenui-labs/readme-studio.git](https://github.com/zenui-labs/readme-studio.git) cd readme-studio

2. Install dependencies:

npm install

3. Create a .env file in the root directory with required environment variables. And after create add VITE_GOOGLE_API_KEY your google gemini api key (otherwise the readme ai generation will not work).

cp .env.example .env

4. Start the development server:

npm run dev

The application will be available at http://localhost:5173

🚀 Production Build

To create a production build:

npm run build

To preview the production build:

npm run preview

📄 License

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

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details on how to submit pull requests, report issues, and contribute to the project.

🌟 Show Your Support

Give a ⭐️ if this project helped you!

📞 Contact

For questions, suggestions, or issues, please use:

• GitHub Issues: Create an issue
• Email: [email protected]