readme-md-generator
Advanced tools
CLI that generates beautiful README.md files.
readme-md-generatorwill suggest you default answers by reading yourpackage.jsonandgitconfiguration.
readme-md-generator is able to read your environment (package.json, git config...) to suggest you default answers during the README.md creation process:
Generated README.md:
Example of package.json with good meta data:
// The package.json is not required to run README-MD-GENERATOR
{
"name": "readme-md-generator",
"version": "0.1.3",
"description": "CLI that generates beautiful README.md files.",
"author": "Franck Abgrall",
"license": "MIT",
"homepage": "https://github.com/kefranabg/readme-md-generator#readme",
"repository": {
"type": "git",
"url": "git+https://github.com/kefranabg/readme-md-generator.git"
},
"bugs": {
"url": "https://github.com/kefranabg/readme-md-generator/issues"
},
"engines": {
"npm": ">=5.5.0",
"node": ">=9.3.0"
}
}
Make sure you have npx installed (npx is shipped by default since npm 5.2.0)
Just run the following command at the root of your project and answer questions:
npx readme-md-generator
Or use default values for all questions (-y):
npx readme-md-generator -y
Use your own ejs README template (-p):
npx readme-md-generator -p path/to/my/own/template.md
You can find ejs README template examples here.
This project exists thanks to all the people who contribute. [Contribute].
Become a financial contributor and help us sustain our community. [Contribute]
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
Contributions, issues and feature requests are welcome.
Feel free to check issues page if you want to contribute.
Check the contributing guide.
👤 Franck Abgrall
Please ⭐️ this repository if this project helped you!
Copyright © 2019 Franck Abgrall.
This project is MIT licensed.
This README was generated with ❤️ by readme-md-generator
1.0.0 (2019-12-03)
<a name="0.7.0"></a>
FAQs
CLI that generates beautiful README.md files.
The npm package readme-md-generator receives a total of 1,223 weekly downloads. As such, readme-md-generator popularity was classified as popular.
We found that readme-md-generator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.