grunt-steroids-setup v0.0.12

grunt-steroids-setup

Script the creation of a steriods build

Getting Started

This plugin requires Grunt ~0.4.4

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-steroids-setup --save-dev

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

grunt.loadNpmTasks('grunt-steroids-setup');

The "steroids_create" task

Overview

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

grunt.initConfig({
  'steroids_create': {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.buildFolder

Type: String Default value: ./build

The build folder to create the Steroids template in

options.steroidsPath

Type: String Default value:

Path to the steroids application

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)