Project README Gen — Minimalist Documentation Studio

Primary Language —

Project Type —

Detected License —

Total Files & Dirs —

Folder Structure & Detection

Depth: Auto

Click "Scan Directory" above to analyze your repository structure and build our ASCII visualizer.

README Studio

Ready to Generate

Scan your directory or select a template to generate documentation.

Project Directory

Groq AI Model

Architectural Tone

Custom Architectural Instructions (Optional)

AI Generated Documentation

Model: llama-3.3-70b

Configure & Architect

Select your tone and instructions above to generate a custom, project-aware README via Groq LLM.

Profile Setup & Configuration

GitHub Username *

Visual Style Preset

Animated Typing Tagline

GitHub Token (Optional for higher rate limits)

Live Profile Metrics Preview

Enter Username

We'll fetch public repositories, language distribution, and GitHub stats to populate your custom profile.

Profile README Studio

Style: Professional

Your Profile Masterpiece

Click "Generate Profile README" to create a clean GitHub profile with live shields and dynamic stats.

Groq API Key Configuration

Required for AI README Generation and Groq integration.

Your Groq API Key

Get Free API Key

Usage Quotas & System Status

Real-time metrics monitored via local state.

Groq Free Tier Rate Limit 30 RPM / 14,400 RPD Ample quota for rapid documentation iteration

Inference Speed ~300+ Tokens/Sec Powered by Groq LPU™ Engine

Local Cache Status Active & Atomic Zero redundant disk scans on unchanged folders

Project Studio