README.md 1.25 KB

grunt-bosonic

A Grunt task that transpiles to-the-spec Web Components into polyfilled JavaScript

Getting Started

This plugin requires Grunt ~0.4.2

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-bosonic --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-bosonic');

The "bosonic" task

Usage

In your project's Gruntfile, add a section named bosonic to the data object passed into grunt.initConfig().

grunt.initConfig({
  bosonic: {
    my_components: {
      src: ['src/**/*.html'],
      css: 'dist/components.css',
      js:  'dist/components.js'
  }
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)