md-generate v1.2.2

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

 {
  "name": "md-generate",
  "version": "1.0.0",
  "description": "CLI which generates README.md based on package.json and Git config. It also can overwrite package.json file with data from inputs.",
  "homepage": "https://www.npmjs.com/package/md-generate",
  "repository": {
    "type": "git",
    "url": "git@github.com:teziovsky/md-generate.git"
  },
  "engines": {
    "node": ">=v14.0.0",
    "npm": ">=v6.0.0"
  },
  "bugs": {
    "url": "https://github.com/teziovsky/md-generate/issues",
    "email": "teziovsky@gmail.com"
  },
  "license": "MIT License",
  "author": {
    "name": "Jakub Soboczyński",
    "email": "kontakt@jakubsoboczynski.pl",
    "url": "https://www.jakubsoboczynski.pl"
  }
}

Get started 🔥

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

Install as a global package and run

  npm install -g md-generate
  # or
  pnpm add -g md-generate
  # then
  md-generate

If you have npx installed

  npx md-generate
  # or
  pnpx md-generate

Author 🙎🏼‍

@teziovsky

Contact ☎️

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

License 🧾

MIT License

README created with ❤️ by md-generate