first commit

examples/webpack/README.md

@@ -0,0 +1,33 @@
+## Overview
+
+Example to demonstrate PDF.js library usage with Webpack.
+
+## Getting started
+
+Install the example dependencies and build the project:
+
+    $ gulp dist-install
+    $ cd examples/webpack
+    $ npm install
+    $ ./node_modules/webpack/bin/webpack.js
+
+You can observe the build results by running `gulp server` and navigating to
+http://localhost:8888/examples/webpack/index.html.
+
+Refer to the `main.js` and `webpack.config.js` files for the source code.
+Note that PDF.js packaging requires packaging of the main application and
+the worker code, and the `workerSrc` path shall be set to the latter file.
+
+### Minification
+
+If you are configuring Webpack to output a minified build, please note that you
+*must* configure the minifier to keep original class/function names intact;
+otherwise the build is not guaranteed to work correctly.
+
+## Worker loading
+
+If you are getting the `Setting up fake worker` warning, make sure you are
+importing `pdfjs-dist/webpack.mjs` which is the zero-configuration method for
+Webpack users. Installing `worker-loader` is no longer necessary.
+
+    import * as pdfjsLib from 'pdfjs-dist/webpack.mjs';