<commit_before># grunt-flaticon

Grunt task to automatically download flaticon icons collection from config stored in JSON file

## 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:<commit_msg>README update<commit_after># grunt-flaticon

Grunt task to automatically download flaticon icons collection from config stored in JSON file

## 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:

## Options

- config - path to flaticon.json configuration file
- fonts - path to directory where fonts will be downloaded
- styles - css or less file where icons classes will be stored
- cache_dir - directory for caching zip
- use_less - disable or enable generating style in less

## Example

Example configuration

	flaticon: {
		dist: {
			options: {
				config: 'flaticon.json',
				fonts: 'web/fonts/',
				styles: 'web/css/flaticon.less',
				cache_dir: 'app/cache/',
				use_less: true
			}
		}
	}

Example flaticon.json

	{
		"css_prefix_text": "flaticon-",
		"icons": {
			"i1981": {
				"id": "1981",
				"keyword": "close"
			},
			"i2470": {
				"id": "2470",
				"keyword": "twitter"
			},
			"i3526": {
				"id": "3526",
				"keyword": "minus-filled"
			}
		}
	}
{'fraction_non_alphanumeric': 0.10919849381387843, 'fraction_numerical': 0.012910166756320602, 'mean_word_length': 3.7570332480818416, 'pattern_counts': {'":': 11, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 3, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5022776', 'n_tokens_mistral': 662, 'n_tokens_neox': 572, 'n_words': 210}