cubx-generate-webpackage-readme-file

Module for generating the readme file of a webpackage.

Usage:

Command line:

ubx-generate-webpackage-readme-file -p <...> -s <...> [--includeSample <...> --sampleArtifactId <...> includeInit: <...> sampleSlotName: <...> sampleSlotValue: <...>] 

Other npm modules

var WebpackageReadmeGenerator = require('cubx-generate-webpackage-readme-file');

var webpackagePath = ...;

var options = {
    storeName: ..., 
    includeSample: ...,
    sampleArtifactId: ...,
    includeInit: ...,
    sampleSlotName: ...,
    sampleSlotValue: ...
};

var generator = new WebpackageReadmeGenerator(webpackagePath);
generator.setTemplateValues(options);
generator.generateReadmeFile();

Parameters

• webpackagePath or -p: (string, required) path of the webpackage.
• storeName or -s: (string, required) Name of the store where the webpackage is hosted. To be used for the links associated to each artifact.
• includeSample: (boolean) indicates whether an example using a component should be include.
• sampleArtifactId: (string, required if includeSample === true) It is the artifactId of the component to be used as example.
• includeInit: (boolean) indicates whether a demo of how to initialise the example component should be include.
• sampleSlotName: (string, required if includeInit === true) It is the slotId of the slot to be used for the initialisation demo.
• sampleSlotValue: (any, required if includeInit === true) It is the value of the slot to be used for the initialisation demo. It should be JSON valid.