grunt-pugpig-editions-xml
Version:
Generate editions XML file for PugPig publications.
65 lines (46 loc) • 1.96 kB
Markdown
# grunt-pugpig-editions-xml [](https://travis-ci.org/furzeface/grunt-pugpig-editions-xml)
> Generate editions XML file for PugPig.
## In development
Todo:
* More than one edition
* More tests
* Options docs
* Usage examples
## Getting Started
This plugin requires Grunt.
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-pugpig-editions-xml --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-pugpig-editions-xml');
```
## The "pugpig_editions_xml" task
### Overview
In your project's Gruntfile, add a section named `pugpig_editions_xml` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
pugpig_editions_xml: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
```
### Options
### Usage Examples
## 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).
```
$ grunt test
```
Commit messages loosely adhere to [these guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit).
Versioning adheres to [Semver](http://semver.org).
## Release History
- 2014-08-18 v0.1.0 - Initial release.
## License
Copyright (c) 2014 Daniel Furze. Licensed under the MIT license: http://danielfurze.mit-license.org