html-modules - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

		{
		"name": "html-modules",
		"description": "allows to include small html parts in other html",
		"version": "0.0.1",
		"version": "0.0.2",
		"homepage": "https://github.com/legomushroom/grunt-plugin",
		@@ -32,12 +32,6 @@ "author": {
		"devDependencies": {
		"grunt-contrib-jshint": "~0.6.0",
		"grunt-contrib-clean": "~0.4.0",
		"node-fs": "~0.1.7",
		"jquery-deferred": "*",
		"lodash": "*",
		"html": "*",
		"jquery":"*",
		"path": "~0.4.9",
		"grunt-contrib-nodeunit": "~0.2.0",
		"grunt-contrib-coffee": "~0.6.0",
		"grunt-contrib-watch": "~0.3.1",
		@@ -44,0 +38,0 @@ "grunt": "~0.4.1"

README.md

		@@ -5,86 +5,2 @@ # html-modules

		## Getting Started
		This plugin requires Grunt `~0.4.1`

		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 html-modules --save-dev
		```

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

		```js
		grunt.loadNpmTasks('html-modules');
		```

		## The "html_modules" task

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

		```js
		grunt.initConfig({
		html_modules: {
		options: {
		// Task-specific options go here.
		},
		your_target: {
		// Target-specific file lists and/or options go here.
		},
		},
		})
		```

		### Options

		#### options.separator
		Type: `String`
		Default value: `', '`

		A string value that is used to do something with whatever.

		#### options.punctuation
		Type: `String`
		Default value: `'.'`

		A string value that is used to do something else with whatever else.

		### Usage Examples

		#### Default Options
		In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`

		```js
		grunt.initConfig({
		html_modules: {
		options: {},
		files: {
		'dest/default_options': ['src/testing', 'src/123'],
		},
		},
		})
		```

		#### Custom Options
		In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`

		```js
		grunt.initConfig({
		html_modules: {
		options: {
		separator: ': ',
		punctuation: ' !!!',
		},
		files: {
		'dest/default_options': ['src/testing', 'src/123'],
		},
		},
		})
		```

		## 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)_
		comming soon

html-modules - npm Package Compare versions

Improved metrics

Worsened metrics