AI-powered documentation generator

Generate READMEs, contribution guides, commit messages, Dockerfiles, and more—automatically.

# Install readmit

$ go install github.com/treasureuzoma/readmit/readmit@latest

# Generate documentation

$ readmit generate readme

✓ Analyzing codebase...

✓ Generated README.md

What readmit generates

Comprehensive project documentation with installation, usage, and API references

Contributor guidelines based on your project structure and coding patterns

Intelligent commit message suggestions following conventional commit standards

Optimized Docker configurations tailored to your tech stack

Auto-generated API docs from your route handlers and endpoints

Report showiwng all your codebase vulnerbility

Reads your entire codebase, understanding structure, dependencies, and patterns

AI processes your code to understand functionality, architecture, and best practices

Creates comprehensive, accurate documentation tailored to your specific project

Let readmit understand your code and generate professional documentation in seconds.