update README

broofa · Sep 13, 2017 · f7a2f74 · f7a2f74
1 parent efc8138
commit f7a2f74
Show file tree

Hide file tree

Showing 4 changed files with 258 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -2,8 +2,16 @@
 
 A comprehensive, compact MIME type module.
 
-This is version `2.x`.  Docs for the previous version, `1.4.0`, may be found
-[here](https://github.com/broofa/node-mime/tree/v1.4.0).
+## Version 2 Notes
+
+Version 2 is a breaking change from 1.x, as the semver implies.  Specifically:
+
+* ES6 support required (requires Node 6+)
+* `lookup()` renamed to `getType()`
+* `extension()` renamed to `getExtension()`
+* `charset()` and `load()` methods have been removed
+
+If you need the legacy version of this module for any reason, please `npm install mime@^1`.  Version 1 docs may be found [here](https://github.com/broofa/node-mime/tree/v1.4.0).
 
 ## Install - NPM
 ```

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -23,6 +23,7 @@
     "github-release-notes": "0.9.0",
     "mime-db": "1.30.0",
     "mime-types": "2.1.15",
+    "mocha": "3.5.3",
     "runmd": "0.1.8"
   },
   "scripts": {

diff --git a/src/README_js.md b/src/README_js.md
@@ -5,8 +5,16 @@ runmd.onRequire = path => path.replace(/^mime/, '..');
 
 A comprehensive, compact MIME type module.
 
-This is version `2.x`.  Docs for the previous version, `1.4.0`, may be found
-[here](https://github.com/broofa/node-mime/tree/v1.4.0).
+## Version 2 Notes
+
+Version 2 is a breaking change from 1.x, as the semver implies.  Specifically:
+
+* ES6 support required (requires Node 6+)
+* `lookup()` renamed to `getType()`
+* `extension()` renamed to `getExtension()`
+* `charset()` and `load()` methods have been removed
+
+If you need the legacy version of this module for any reason, please `npm install mime@^1`.  Version 1 docs may be found [here](https://github.com/broofa/node-mime/tree/v1.4.0).
 
 ## Install - NPM
 ```