Hey it's md-generate! 🖖🏼

CLI which generates README.md based on package.json and Git config. It also can overwrite package.json file with data from inputs.

Example of good package.json

1 {
2  "name": "md-generate",
3  "version": "1.0.0",
4  "description": "CLI which generates README.md based on package.json and Git config. It also can overwrite package.json file with data from inputs.",
5  "homepage": "https://www.npmjs.com/package/md-generate",
6  "repository": {
7    "type": "git",
8    "url": "git@github.com:teziovsky/md-generate.git"
9  },
10  "engines": {
11    "node": ">=v14.0.0",
12    "npm": ">=v6.0.0"
13  },
14  "bugs": {
15    "url": "https://github.com/teziovsky/md-generate/issues",
16    "email": "teziovsky@gmail.com"
17  },
18  "license": "MIT License",
19  "author": {
20    "name": "Jakub Soboczyński",
21    "email": "kontakt@jakubsoboczynski.pl",
22    "url": "https://www.jakubsoboczynski.pl"
23  }
24}

Get started 🔥

Open the root (where package.json is) directory of your project and:

Install as a global package and run

1  npm install -g md-generate
2  # or
3  pnpm add -g md-generate
4  # then
5  md-generate

If you have npx installed

1  npx md-generate
2  # or
3  pnpx md-generate

Author 🙎🏼‍

@teziovsky

Contact ☎️

If you have any suggestions, please email me here! 🔥

License 🧾

MIT License

---

README created with ❤️ by md-generate