Adding doc

Author: pgaultier

README.md

@@ -82,6 +82,7 @@ if you need to regenerate one of the files, you can use the following CLI comman
   * `php protected/yii webpack/generate-config` : regenerate `webpack-yii2.json`
   * `php protected/yii webpack/generate-package` : regenerate `package.json`
   * `php protected/yii webpack/generate-webpack` : regenerate `webpack.config.js`
+  * `php protected/yii webpack/generate-generate-typescript-config` : regenerate `tsconfig.json`
 
 ### Sample application structure
 
@@ -121,13 +122,16 @@ The typical answer when running `php protected/yii webpack` would be :
 
  * **Generating webpack.config.js** 
 
+ * **Generating tsconfig.json** 
+
 Application structure with generated files will be
 
  * *index.php*
  * *composer.json*
  * *package.json*
  * *webpack-yii2.json*
  * *webpack.config.js*
+ * *tsconfig.json*
  * **protected**
    * *yii* (console script)
    * **assets**
@@ -198,13 +202,53 @@ When your assets are ready, you have to make sure following files are added to y
  * `package.json` node package management
  * `webpack.config.js` needed to run webpack
  * `webpack-yii2.json` needed by webpack.config.js to define you app entry points and the target directories
+ * `tsconfig.json` needed by webpack.config.js to handle Typescript files
 
  * `<appdir>/assets/webpack/assets-catalog.json` to let the webpack aware asset find the dist files
  * `<appdir>/assets/webpack/dist` to keep the assets (they are not dynamically generated when asset is registered)
  * `<appdir>/assets/webpack/src` because you want to keep your sources :-)
 
 
+### File `webpack-yii2.json` explained
+ 
+```json
+{
+    "sourceDir": "protected\/assets\/webpack",
+    "entry": {
+        "app": "./app.ts"
+    },
+    "commonBundles": [
+        "manifest"
+    ],
+    "externals": {
+
+    },
+    "subDirectories": {
+        "sources": "src",
+        "dist": "dist"
+    },
+    "assets": {
+        "styles": "css",
+        "scripts": "js"
+    },
+    "catalog": "assets-catalog.json"
+}
+```
 
+#### Specific to yii2-webpack module
+
+ * **sourceDir** relative path to the directory where assets will be managed
+ * **subDirectories** subpath (in *< sourceDir >*) of sources and distribution files
+ * **assets** subpath (in *< sourceDir >/< subDirectories.dist >*) of styles and scripts assets
+ * **catalog** name of assets catalog, must be in synch with `WebpackAssetBundle::$webpackAssetCatalog`
+  
+#### Mapped to Webpack vars
+  
+ * **entry** object syntax entry points [Webpack entry documentation](https://webpack.js.org/concepts/entry-points/#object-syntax)
+ * **commonBundles** explicit vendor chunk [Webpack CommonChunkPlugin documentation](https://webpack.js.org/plugins/commons-chunk-plugin/#explicit-vendor-chunk)
+ * **externals** object syntax externals [Webpack externals documentation](https://webpack.js.org/configuration/externals/#object)
+ 
+ 
 Contributing
 ------------