Professional README generation for your projects, right where you code. No web interface, no context switching. Just pure terminal efficiency.
npm install -g rdme.shEverything you need to generate perfect READMEs, nothing you don't
Generate comprehensive READMEs in seconds. No waiting, no loading screens.
Automatically detects your project structure, dependencies, and configuration.
Industry-standard formatting with badges, sections, and proper markdown.
No web interface needed. Everything happens in your terminal, your way.
Control every aspect of your README generation with a simple config file. Automatically generated on init, customize sections, badges, table of contents, and more.
sectionsChoose which sections to include
badgesAuto-generate project badges
tocInclude table of contents
templateSelect your preferred template style
Four simple commands to perfect documentation
$ npm install -g rdme.shOne command to install rdme.sh on your system with your favorite package manager.
$ cd your-projectCD into any project directory. rdme.sh works with all types of Node.js projects.
$ rdme initExecute the command and watch as rdme.sh analyzes your project and generates a README.
✨ README.mdYour professional README.md is ready. Customize it further or ship it as-is.
Install with any package manager
npm install -g rdme.shbun add -g rdme.shpnpm add -g rdme.shyarn global add rdme.shnpx rdme.shni -g rdme.shJoin thousands of developers generating professional READMEs in seconds