@kingjs/readme-template v1.0.6

@kingjs/readme-template

The master readme template for the kingjs scope.

Usage

Given a package.json like this:

{
  "name": "@kingjs/readme-template.test",
  "version": "1.0.0",
  "description": "Test of the master readme template for the `kingjs` scope.",
  "main": "index.js",
  "files": [
    "*.js"
  ],
  "repository": {
    "type": "git",
    "url": "https://repository.kingjs.net/readme-template"
  },
  "license": "MIT",
  "dependencies": {
    "@kingjs/readme-template": "^1.0.5"
  },
  "devDependencies": {},
  "readmeTemplate": "@kingjs/readme-template"
}

And given a index.js like this:

/**
 * @this any This comment
 * @param foo Foo comment
 * @param [bar] Bar comment
 * @param [baz] Baz comment
 * @returns The return comment.
 */
function example(foo, bar, baz) { }

Then...

Install

With npm installed, run

$ npm install @kingjs/readme-template

License

MIT