README.md

wcdoc

Simple API Document Generator for Web Components.

Install

Install with npm

$ npm install wcdoc

Examples

var wcdoc = require('wcdoc');

wcdoc.run({
  src: ['src/**/*.js'],
  basePath: __dirname
}).then(function(result) {
  console.log(result);
});

Running tests

Install locked dev dependencies with Yarn:

$ yarn install && yarn test