AI README generator
Rough project notes in, a complete README.md with install, usage and options table out.
Your key stays in your browser.It goes straight to the provider, never to our servers, and we neither log nor keep it. Use a dedicated key with a spending cap, and delete it in the provider's dashboard when you are done.
Input
Result
The result will appear here.Most projects ship with a README that says "TODO". Paste whatever you have — a one-line description, your package.json, the CLI's --help output, a list of commands — and get a complete README.md: title and tagline, badges, features, requirements, installation, usage with a copy-pasteable example, an options table, development, contributing and license. The section order follows kefranabg/readme-md-generator, the popular README scaffolding CLI; the difference is that you do not have to answer its questions one by one.
How it works
- Anything the notes do not state — a repository URL, a version, the license — becomes a visible <!-- TODO --> placeholder rather than an invented fact.
- Flags, options and environment variables in your notes are turned into a table with option, default and description columns.
- Write the notes in Chinese and still ask for an English README, or the other way round; commands and code are never translated.
Where your data goes
With your own key, what you type and the key go from your browser straight to the provider you choose; neither passes through Hysen Labs. In hosted mode, your text goes through our server to our provider (DeepSeek) and is billed in credits; we keep the token counts and cost of each run for billing, never the text itself or the answer. How the provider handles the text is governed by its own privacy policy.
This tool handles keys and credentials, so nothing about a run is saved, not even to your own history.
About your API key
We do not collect, store or leak your key: it lives only in this page's memory (unless you tick “remember in this tab”) and is gone when you close it. Still, treat any key you have pasted into a web page with care — create a dedicated key with a spending cap for use here, and delete or rotate it in your provider's dashboard when you are done.
What it costs
This tool is free, with no sign-in and no points.
Common questions
- Will it make up features or badges?
- It is instructed not to, and missing facts are left as placeholders. Badges are only added for things your notes establish, like an npm package name or a license, and they use shields.io URLs; turn badges off if you do not want them.
- What should I paste for the best result?
- The package manifest (package.json, pyproject.toml or Cargo.toml), the --help output, and a sentence on who the project is for. Real flag names and install commands give a README that is correct as well as tidy.
- Where do my notes and key go?
- Straight from this page to the AI provider you picked, using your key; hysenlabs.com keeps nothing. For an unreleased project, use a provider whose terms you accept and a key made just for this, then remove the key.
The open-source behind it
This tool is a self-contained implementation. kefranabg/readme-md-generator (MIT) does the same job as a library — if you need this behaviour inside your own program, start there rather than calling a web page.
kefranabg/readme-md-generatorAlso known as
- readme generator
- ai readme generator
- readme.md template
- github readme generator
- generate readme from package.json