Merge pull request #1 from KyleRoss/2.0.0-dev

Release 2.0.0

.gitignore

@@ -1,3 +1,4 @@
 logs
 *.log
 node_modules
+.DS_Store

HISTORY.md

@@ -1,4 +1,23 @@
 # ModClean Benchmark History
 
+## 2.0.0 (1/11/2016)
+* **New!** Added `-a, --additional-patterns` option.
+* **New!** Added `-I, --ignore` option.
+* **New!** Added `-s, --case-sensitive` option.
+* **New!** Added `--no-dirs` option.
+* **New!** Added `--no-dotfiles` option.
+* **New!** Added `-k, --keep-empty` option.
+* **New!** Added `--no-log` option.
+* **Breaking** Replaced `-d, --empty` option with the new `-k, --keep-empty` option.
+* Rewritten using ES6 (requires Node v6.9+)
+* Updated all dependencies to their latest versions.
+* Updated to ModClean 2.0.0.
+* Replaced `colors` with `chalk`.
+* Replaced `cli-table` with `cli-table2`.
+* Replaced `cli-spinner` with `ora`.
+* Improved output of NPM commands.
+* Reduced log file output.
+* Misc. display and performance updates/fixes.
+
 ## 1.0.0 (4/27/2015)
 * Initial release

README.md

@@ -1,7 +1,9 @@
 # ModClean Benchmark Utility
 [![npm version](https://img.shields.io/npm/v/modclean-benchmark.svg)](https://www.npmjs.com/package/modclean-benchmark) ![NPM Dependencies](https://david-dm.org/KyleRoss/modclean-benchmark.svg) [![NPM Downloads](https://img.shields.io/npm/dm/modclean-benchmark.svg)](https://www.npmjs.com/package/modclean-benchmark) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/KyleRoss/modclean-benchmark/master/LICENSE) [![GitHub issues](https://img.shields.io/github/issues/KyleRoss/modclean-benchmark.svg)](https://github.com/KyleRoss/modclean-benchmark/issues)
 
-Quickly run a benchmark test for [ModClean](https://github.com/KyleRoss/modclean). I started to get tired of manually running benchmark tests, so I threw together this small Node script that does it for you.
+Quickly run a benchmark test for [ModClean](https://github.com/ModClean/modclean). I started to get tired of manually running benchmark tests, so I threw together this small Node script that does it for you.
+
+Note that version `2.0.0` is for ModClean 2.x, if you want to benchmark the old version, use version `1.0.0` of this module.
 
 ## Install
 
@@ -18,18 +20,41 @@ Once installed globally, you will have access to `modclean-benchmark` through co
 These are the available flags/options for `modclean-benchmark`.
 
 #### -n, --patterns [patterns]
-Specify which group(s) of patterns to use. Can be `safe`, `caution` or `danger`. Separate multiple groups by a single comma (no spaces). Default is `safe`. 
-Example: `modclean-benchmark -n safe,caution`
+Specify which pattern plugins/rules to use. Separate multiple groups by a single comma (no spaces). Default is `default:safe`. 
+Example: `modclean-benchmark -n default:safe,default:caution`
 
 #### -m, --modules [modules]
 Specify which npm modules to use for the benchmark. Multiple modules should be separated by a single comma (no spaces). Default is `express,lodash,moment,async`.
 Example: `modclean-benchmark -m express,underscore,numeral,fs-extra`
 
-#### -c, --no-clean
+#### -a, --additional-patterns [patterns]
+Specify additional custom glob patterns to use along with the patterns that are loaded from `-n`.  
+Example: `modclean-benchmark --additional-patterns="*.html,contributing*"`
+
+#### -I, --ignore [patterns]
+Specify glob patterns to ignore while searching for files. Useful if a prexisting pattern matches a module name you do not want removed.  
+Example: `modclean-benchmark --ignore="npm-license-lookup"`
+
+#### -s, --case-sensitive
+Enable case sensitive checking when locating files based on the patterns.
+
+#### --no-dirs
+Disable removal of directories.
+
+#### --no-dotfiles
+Exclude dot files from being removed.
+
+#### -k, --keep-empty
+Prevents removal of empty directories.
+
+#### --no-log
+Do not create a log file when the process is complete.
+
+#### --no-clean
 Turn off post-modclean cleanup process. By default, this script will cleanup the modules downloaded from npm after the process is complete and the benchmarks are ran, if you would rather keep the files, use this flag.
 
 ## Submitting Benchmarks
-Feel free to submit benchmark results in the proper format in the [ModClean repository](https://github.com/KyleRoss/modclean) by creating a pull request.
+Feel free to submit benchmark results in the proper format in the [ModClean repository](https://github.com/ModClean/modclean) by creating a pull request.
 
 ## License
 Licensed under the MIT License. See `LICENSE` in the repository for the full text.