0.1.0 • Published 9 years ago
grunt-update-readme v0.1.0
grunt-update-readme
Update readme file to package.json
Getting Started
This plugin requires Grunt ~0.4.5
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-update-readme --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-update-readme');
The "update_readme" task
Overview
In your project's Gruntfile, add a section named update_readme
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
update_readme: {
'package.json': {
'readme': 'README.md'
// Other fields from a file
}
// Other files you want to import
},
});
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)
0.1.0
9 years ago