Readme Studio
AI that generates clean, structured, professional READMEs you can edit and preview live.
- Product
- Readme Studio
- Status
- Active
- Stack
- Vue, TypeScript, Vite, Pinia, Tailwind CSS, Google Gemini
- Updated
- 2026-09-29
The problem
A README is the front door of a project, and it is usually written last and in a hurry. Missing setup steps and unclear structure cost every future contributor time.
The answer
What we built instead.
Readme Studio uses AI to write meaningful, professional README files tailored to your project. Generate a draft, refine it in the built-in markdown editor with a live GitHub-style preview, or start from a pre-built template. It is open source, with more than 100 stars on GitHub.
AI generation
Describe the project and Google Gemini drafts a README in a clear, conventional structure.
Markdown editor with live preview
Edit the draft and see it rendered the way GitHub will show it, side by side.
Templates
Start from pre-built README templates for projects and profiles instead of a blank page.
Safe output
Rendered markdown is sanitised with DOMPurify before it is shown.
How it behaves
From input to result, in 4 moves.
react-table-kit
npm v1.2.0build passingMIT
Sortable, paginated tables for React.
Installation
npm install react-table-kit
Usage
<Table data={rows} sortable />
Input
Describe the project.
Generate
The model drafts a structured README.
Refine
Edit and correct the draft.
Publish
Commit it to the repository.
Try it
Try the idea without leaving the page.
A small playground built with browser APIs. It shows the principle; the real tool does far more.
# my-project A small library that does one thing well. ## Installation ```bash npm install my-project ``` ## Usage ## Contributing ## License
Under the hood
Under the hood.
- InterfaceVue 3 · TypeScript · Pinia · Vue Router · Tailwind CSS
- GenerationGoogle Gemini API
- OutputMarkdown (Marked) · Sanitised with DOMPurify
Who it is for
Open-source maintainers
Give a new repository a complete README before announcing it.
Teams
Bring internal repositories to a consistent documentation standard.
Put Readme Studio to work.
Works alongside