readme

Author: developit

README.md

@@ -1,22 +1,56 @@
 # Optimize Plugin for Webpack
 
-Optimize your code for modern browsers while still supporting the other 10%, increasing your build performance, reducing bundle size and improving output quality.
+Optimize your code for modern browsers while still supporting the other 10%,
+increasing your build performance, reducing bundle size and improving output quality.
 
 Put simply: it compiles code faster, better and smaller.
 
-### Features
+## Features
 
 - Much faster than your current Webpack setup
 - Transparently optimizes all of your code
 - Automatically optimizes all of your dependencies
 - Compiles bundles for modern browsers (90%) and legacy browsers (10%)
 - Removes unnecessary polyfills, even when inlined into dependencies
-- Compiles a highly-optimized dedicated polyfills bundle
+- Builds a highly-optimized automated polyfills bundle
+
+## Usage
+
+First, disable any existing configuration you have to Babel, minification, and module/nomodule.
+
+Then, add `OptimizePlugin` to your Webpack plugins Array:
 
 ```js
 plugins: [
   new OptimizePlugin({
-    // options
+    // any options here
   })
 ]
 ```
+
+### Options
+
+| Option | Type | Description
+|---|---|---
+| `concurrency` | `number|false` | Maximum number of threads to use. Default: the number of available CPUs. <br>_Pass `false` for single-threaded, sometimes faster for small projects._
+
+
+## How does this work?
+
+Instead of running Babel on each individual source code file in your project, `optimize-plugin`
+transforms your entire application's bundled code. This means it can apply optimizations and
+transformations not only to your source, but to your dependencies - making polyfill extraction
+and reverse transpilation steps far more effective.
+
+This setup also allows `optimize-plugin` to achieve better performance. All work is done in
+a background thread pool, and the same AST is re-used for modern and legacy transformations.
+Previous solutions for module/nomodule have generally relied running two complete compilation
+passes, which incurs enormous overhead since the entire graph is built and traversed multiple
+times. With `optimize-plugin`, bundling and transpilation are now a separate concerns: Webpack
+handles graph creation and reduction, then passes its bundles to Babel for transpilation.
+
+<img src="https://user-images.githubusercontent.com/105127/74685954-0cd21a80-519e-11ea-99f9-8fa5f3aef1b8.png">
+
+### License
+
+Apache-2.0