Transform your code into professional documentation instantly
AutoReadme is a cutting-edge web application that leverages Google's Gemini AI to automatically generate comprehensive, professional README files for your projects. Simply upload your project folder locally, and watch as AI analyzes your code structure, dependencies, and architecture to create production-ready documentation in seconds.
- 🤖 AI-Powered Analysis - Uses Google Gemini AI for intelligent code understanding
- 📁 Folder Upload - Drag & drop entire project folders for complete analysis
- 🔍 Smart Detection - Automatically identifies languages, frameworks, and dependencies
- 🎨 Multiple Templates - Purpose-driven templates (SaaS, Open Source, Academic, etc.)
- ⚡ Instant Generation - Professional README in under 30 seconds
- 📋 One-Click Copy - Copy generated content directly to clipboard
- 💾 Download Ready - Export as markdown file
- 🔒 Privacy First - All processing happens client-side
Experience AutoReadme in action here: AutoReadme
- HTML5 - Semantic markup and structure
- CSS3 - Modern styling with CSS Grid and Flexbox
- Vanilla JavaScript - No framework dependencies for maximum performance
- Google Gemini API - Advanced language model for content generation
- Netlify - Serverless deployment with environment variables
- Build Optimization - Automated deployment pipeline
AutoReadme intelligently detects and documents:
- JavaScript, TypeScript, Python, Java, C++, C#, PHP, Ruby, Go, Rust, HTML, CSS
- Frontend: React, Vue.js, Angular, Next.js, Svelte
- Backend: Express.js, Django, Flask, FastAPI, Spring Boot
- Database: MongoDB, MySQL, PostgreSQL, Redis
- Tools: Docker, Webpack, Vite, Babel
- npm/yarn (package.json)
- pip (requirements.txt)
- Maven (pom.xml)
- Gradle (build.gradle)
- Open Source Projects - Create compelling project descriptions
- Portfolio Projects - Professional documentation for showcasing
- Hackathon Submissions - Quick, comprehensive project overviews
- Client Projects - Standardized documentation delivery
- Code Reviews - Consistent documentation standards
- Onboarding - Clear project setup instructions
- Knowledge Transfer - Comprehensive project understanding
- Maintenance - Up-to-date project documentation
- Modern web browser (Chrome, Firefox, Safari, Edge)
- Internet connection for AI processing
- Project folder(available locally) to analyze
-
Visit the Application
https://autoreadme.netlify.app -
Upload Your Project
- Click "Try Now" to access the generator
- Select your entire project folder (not individual files)
- Wait for file analysis completion
-
Configure Generation
- Choose your project purpose (SaaS, Open Source, Academic, etc.)
- Select desired README sections
- Add custom descriptions if needed
-
Generate & Export
- Click "Generate Professional README"
- Review the generated content
- Copy to clipboard or download as file
readme-gen/
├── index.html # Landing page
├── generator.html # Main generator interface
├── landing.css # Comprehensive styling
├── landing.js # Landing page interactions
├── script.js # Core application logic
├── env.js # Environment variables (auto-generated)
├── netlify.toml # Deployment configuration
└── build.sh # Build script
# Clone the repository
git clone https://github.com/Divya4879/AutoReadme.git
cd AutoReadme
# Set up environment variables
cp env.js.example env.js
# Edit env.js with your Gemini API key
# Serve locally (using any static server)
python -m http.server 8000
# or
npx serve .Create a .env file or update env.js:
window.ENV = {
GEMINI_API_KEY: 'your-gemini-api-key-here'
};-
Fork this repository
-
Connect to Netlify
- Import your forked repository
- Set build command:
echo 'window.ENV = { GEMINI_API_KEY: "'$GEMINI_API_KEY'" };' > env.js - Set publish directory:
.
-
Configure Environment Variables
- Go to Site Settings → Environment Variables
- Add
GEMINI_API_KEYwith your Google AI Studio API key
-
Deploy
- Netlify will automatically build and deploy
- Your app will be live at
https://your-site-name.netlify.app
- Vercel: Similar setup with environment variables
- GitHub Pages: Requires API key in repository secrets
- Firebase Hosting: Configure with Firebase Functions for API key security
Contributions from developers of all skill levels is welcomed! Here's how you can help:
- 🐛 Bug Reports - Found an issue? Let me know!
- ✨ Feature Requests - Have ideas for improvements?
- 🔧 Code Contributions - Submit pull requests
- 📖 Documentation - Help improve my docs
- 🎨 Design - UI/UX improvements welcome
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Test thoroughly
- Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
- Follow existing code style and conventions.
- Add comments for complex logic.
- Test your changes across different browsers.
- Update documentation if needed.
- Be respectful and constructive in discussions.
- File Size Limits - Large projects (>100MB) may cause browser memory issues
- API Rate Limits - Gemini API has usage quotas
- Language Detection - Some niche languages may not be recognized
- Generation Speed: Average 15-30 secs per project.
- Accuracy Rate: 95%+ for supported languages and frameworks.
- Browser Support: Chrome 80+, Firefox 75+, Safari 13+, Edge 80+.
- Uptime: 99.9% (Netlify hosting)
- Client-Side Processing - Files never leave your browser.
- Secure API Communication - HTTPS encryption for all requests.
- No Data Storage - Your code or generated content is never stored.
- Environment Variables - API keys secured via Netlify environment variables.
This project is licensed under the MIT License - see the LICENSE file for details.
Made with ❤️ by a developer, for developers