11.1K ·GitHub
What is this?
A CLI tool that generates a README.md file for your project by asking you a series of questions and pre-filling smart defaults.
A CLI tool that generates a README.md file for your project by asking you a series of questions and pre-filling smart defaults.Is this a library I import or a standalone CLI?It's a standalone command-line tool you run with npx, not a library you import into code.
It's a standalone command-line tool you run with npx, not a library you import into code.How do I generate a README with it?Run the command at the root of your project and answer the prompted questions, or skip prompts entirely with the -y flag to use default values for all questions.
Run the command at the root of your project and answer the prompted questions, or skip prompts entirely with the -y flag to use default values for all questions.Do I need Node and npm installed first?Yes, it requires npm 5.5.0+ and node 9.3.0+, since it's run via npx.
Yes, it requires npm 5.5.0+ and node 9.3.0+, since it's run via npx.How smart are the suggested defaults?It reads your package.json and git config to suggest default answers during the creation process, so the quality of suggestions depends on how complete your package.json metadata is.
It reads your package.json and git config to suggest default answers during the creation process, so the quality of suggestions depends on how complete your package.json metadata is.Can I customize the README template it generates?Yes, you can supply your own EJS template with the -p flag instead of using the built-in one.
Yes, you can supply your own EJS template with the -p flag instead of using the built-in one.What kind of info does it pull from my project automatically?It reads package.json fields (like name, description, author) and your git configuration to pre-fill answers such as repo name and author info.
It reads package.json fields (like name, description, author) and your git configuration to pre-fill answers such as repo name and author info.What are similar projects?jsdoc, http-server, oc, clarity, Best-README-Template, node-gyp, yeoman, nodemon
jsdoc, http-server, oc, clarity, Best-README-Template, node-gyp, yeoman, nodemonWhich topics is it in?npx, generator, readme, command-line, documentation, markdown, productivity, command-line-tool, npm, terminal, tool, nodejs
npx, generator, readme, command-line, documentation, markdown, productivity, command-line-tool, npm, terminal, tool, nodejs