Blame view

node_modules/grunt-bosonic/README.md 1.25 KB
73bcce88   luigser   COMPONENTS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
  # 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](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
  
  ```shell
  npm install grunt-bosonic --save-dev
  ```
  
  Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
  
  ```js
  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()`.
  
  ```js
  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](http://gruntjs.com/).
  
  ## Release History
  _(Nothing yet)_