touch-readme

Help me create README.md file with the templates

Usage no npm install needed!

<script type="module">
  import touchReadme from 'https://cdn.skypack.dev/touch-readme';
</script>

README

touch-readme

touch-readme Help me create README.md file with the templates.

npm npm npm

Usage

Installation

npm install touch-readme -g

sample

$ touch-readme --help

G:\GitHub\_study\test>touch-readme --help

  Usage: index [options]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number
    -v, --version  output version number
    -n, --npm      create README.md for middleware project
    -c, --complex  create README.md file for complex project

  Examples:

    $ touch-readme
    $ touch-readme -n
    $ touch-readme -c

$ touch-readme -n

    G:\GitHub\_study\test>touch-readme -n

    create G:\GitHub\_study\test\README.md success!

License

MIT

giscafer.com  ·  GitHub @giscafer  ·  Weibo @Nickbing Lao