Fix Issue #790 (#793)

* fix: make wepback plugin available from filer/webpack

* deprecate accessing FilerWebpackPlugin through index.js

* docs: update documentation to reflect changes to FilerWebpackPlugin

* docs: fix typo

README.md

@@ -63,17 +63,28 @@ your webpack config:
 
 ```javascript
 // webpack.config.js
-var filer = require('filer');
+var { FilerWebpackPlugin } = require('filer/webpack');
 
 module.exports = {
   plugins: [
-    new filer.FilerWebpackPlugin(),
+    new FilerWebpackPlugin(),
   ],
 }
 ```
 
+---
+**NOTE**
+
+Previously it was recommended to access the `FilerWebpackPlugin` class by importing the main filer module. This was depracated due [this issue](https://github.com/filerjs/filer/issues/790). For anyone using ***filer version 1.3.1 or earlier***, please import the plugin class like this:
+
+```javascript
+var FilerWebpackPlugin = require('filer/src/webpack-plugin');
+```
+
+---
+
 You can then import the node.js [fs](http://nodejs.org/api/fs.html) and [path](http://nodejs.org/api/path.html)
-modules as normal and FilerWebpackPlugin will ensure that webpack will resolve references to these modules to
+modules as normal and `FilerWebpackPlugin` will ensure that webpack will resolve references to these modules to
 the appropriate filer shims. You will then be able to use these modules as normal (with the exception of the
 synchronous fs methods e.g. `mkdirSync()`).
 

src/index.js

@@ -9,6 +9,15 @@ module.exports = Filer = {
   path: require('./path.js'),
   Errors: require('./errors.js'),
   Shell: require('./shell/shell.js'),
+  /**
+   * @deprecated Importing filer from your webpack config is not recommended.
+   * 
+   * The filer `FilerWebpackPlugin` class is exposed directly. 
+   * 
+   * ```
+   * const { FilerWebpackPlugin } = require('filer/webpack');
+   * ```
+   */
   FilerWebpackPlugin: require('./webpack-plugin'),
 };
 

webpack/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  FilerWebpackPlugin: require('../src/webpack-plugin'),
+};