isabella232 / construx-star

A template for construx plugins

construx-star

construx plugin for JIT-compiling star resources during development of express applications.

REMOVE THIS SECTION

This repository is meant as a template for construx plugins. If you wish to use it:

• create a repository named construx-<wrapped compiler>
• use the github import feature to pull in this repository
• If you aren't a PayPal employee, remove the PayPal license text in the source code
• author your plugin functionality into index.js

If you want the krakenjs team to promote your plugin:

• edit this README to reflect your plugin's requirements, configuration, and purpose
• write unit tests which sufficiently exercise the most likely encountered use cases
• publish your plugin to npm
• Inform us by filing an issue here, to add your plugin to the list of construx plugins
• The team will process your request as quickly as possible

Requirements

This plugin requires your project to have <whatever module>@<whatever semver>.

Usage

Install

$ npm install --save-dev construx-star

Configure

Where you configure your construx plugins:

{
    "star": {
        "module": "construx-star",
        "files": "/star/**/*.compiled",
    }
}

Note: See construx README for general usage of construx