@amjs/create-readme

Allows to create the README.md file of a project

Usage no npm install needed!

<script type="module">
  import amjsCreateReadme from 'https://cdn.skypack.dev/@amjs/create-readme';
</script>

Allows to create the README.md file of a project

$ npm i @amjs/create-readme

Declare an additional script in your package.json file:

{
    "scripts": {
        "doc": "node node_modules/@amjs/create-index"
    }
}

Options	Description
`--d`, `-docs`, `-partials`	Additional Handlebars templates to add into README file