Kubernetes Manifest Studio
Generate Deployment, Service, and Ingress YAML with a drift checklist.
OpenA minimal README skeleton, named and summarized, ready to expand.
The name becomes the top-level heading.
Summarize what the project does in a sentence.
Install, Usage and License placeholders are added.
Download the file, then replace the placeholders.
The repository is about to go public and the README still says TODO. You do not need a polished document yet, just a title, one sentence on what the project does, and an obvious place for install and usage steps.
Enter a project name and a one-line description. The tool writes Markdown with the name as the top heading, your description, an Install section with an npm install code block, a Usage section with npm start, and a License section that says MIT. Copy it or download it as README.md.
The install, usage and license parts are fixed placeholders, not detected from your project. For a Python, Go or Docker project, replace the npm commands with the real ones, and change the license line to whatever you actually chose, since a README that says MIT without a matching LICENSE file confuses people. Worth adding by hand: the minimum runtime version, how to run the tests, and what the project deliberately does not do. Aim to answer the questions a new contributor has in their first ten minutes.
The draft is generated in your browser. Check the rendering in the Markdown preview, compare permissive options in the license picker, and if the project records design decisions, the ADR template builder produces a matching document.
Keyboard shortcut
Answers for this tool. For site-wide help, open the FAQ hub.
No. The Install and Usage sections always use npm install and npm start. Swap them for pip, go, cargo or docker commands as needed.
It is a placeholder. Change it to the license you actually use, and add the complete license text in a LICENSE file at the repository root.
Not through the form. Paste badge Markdown from your CI provider or package registry under the title once you have downloaded the file.