docs: add usage information

Author: iamogbz

.nvmrc

@@ -0,0 +1 @@
+stable

README.md

@@ -5,26 +5,54 @@
 [![Build Status](https://travis-ci.org/iamogbz/webpack-compiler-plugin.svg?branch=master)](https://travis-ci.org/iamogbz/webpack-compiler-plugin)
 [![Coverage Status](https://coveralls.io/repos/github/iamogbz/webpack-compiler-plugin/badge.svg?branch=master)](https://coveralls.io/github/iamogbz/webpack-compiler-plugin?branch=master)
 
-Easily listen to webpack compiler hooks and execute commands on events
+Easily listen to `webpack` compiler hooks and execute commands on events.
 
-## Shell Commands
+## API
 
-```sh
-npm run test      # run jest tests
-```
+This plugin runs your specified commands at keys stages in the `webpack` build process.
 
-```sh
-npm run commit    # run commitizen
-```
+### `buildStart`
 
-```sh
-npm run build     # webpack build
-```
+This is run only once when the `webpack` build is first started, just after plugin are loaded.
 
-### Typescript
+See [webpack.compiler.hook.afterPlugins](https://webpack.js.org/api/compiler-hooks/#afterplugins).
 
-```sh
-make typescript
-```
+### `compileStart`
+
+This is run every time `webpack` starts compiling the source code, can be run multiple times when using the `--watch` flag.
+
+See [webpack.compiler.hook.compilation](https://webpack.js.org/api/compiler-hooks/#compilation).
+
+### `compileEnd`
+
+This is run every time `webpack` finishes compiling the source code, just after the code is emitted.
 
-[Example conversion](https://github.com/iamogbz/node-js-boilerplate/compare/typescript-conversion)
+See [webpack.compiler.hook.done](https://webpack.js.org/api/compiler-hooks/#done).
+
+### `buildEnd`
+
+This is the last stage run only when the build process is exiting. Is also triggered when exiting is caused by a build failure, interrupt signal, etc.
+
+See [node.process.exit](https://nodejs.org/api/process.html#process_event_exit).
+
+## Example
+
+```js
+/* webpack.config.js */
+
+const { execSync } = require("child_process");
+const { WebpackCompilerPlugin } = require("webpack-compile-plugin");
+
+module.exports = {
+    mode: "development",
+    plugins: [
+        new WebpackCompilerPlugin({
+            name: "my-compile-plugin",
+            listeners: {
+                buildStart: () => execSync("echo 'hello'"),
+                buildEnd: () => execSync("echo 'bye bye'"),
+            },
+        }),
+    ],
+};
+```

package-lock.json

@@ -91,6 +91,7 @@
         "@commitlint/cli": "^8.0.0",
         "@commitlint/config-conventional": "^8.0.0",
         "@commitlint/travis-cli": "^8.0.0",
+        "@semantic-release/github": "^5.4.0",
         "@types/chrome": "0.0.81",
         "@types/copy-webpack-plugin": "^4.4.3",
         "@types/jest": "^24.0.9",