update docs

docs/config.md

@@ -0,0 +1,80 @@
+# Configuration of NPMTS
+npmts can be configured to your needs:
+
+### npmextra.json
+the npmts section in npmextra.json can be used to configure npmts.
+
+**Default**
+>Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
+with default behaviour.
+
+```json
+{
+  "npmts":{
+    "mode":"default"
+  }
+}
+```
+
+**Custom settings**
+```json
+{
+  "mode":"custom",
+  "docs":false,
+  "test":true,
+  "npmts":{
+    "ts":{
+      "./customdir/*.ts":"./"
+    },
+    "tsOptions":{
+      "declaration":false,
+      "target":"ES6"
+    },
+    "cli":true
+  }
+}
+```
+
+| key | default value | description |
+| --- | --- | --- |
+| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
+| `"docs"` | `true` | create docs for your module |
+| `"test"` | `true` | test your module |
+| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
+| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
+| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
+
+### TypeScript
+by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
+`./dist/*.js` and `./test/test.js`
+
+Use commonjs module system for wiring up files.
+
+### Declaration files
+**npmts** also creates declaration files like `./dist/index.d.ts` by default.
+You can reference it in your package.json like this.
+
+```json
+"main": "dist/index.js",
+"typings": ".dist/index.d.ts",
+```
+
+This is in line with the latest TypeScript best practices.
+You can then import plugins via the TypeScript `import` Syntax
+and tsc will pick up the declaration file automatically.
+
+### TypeDoc
+By default TypeDoc will create docs for your module in `./pages/api/` directory.
+> Note: Use [npmpage](https://www.npmjs.com/package/npmpage) to build a website for the module.
+It also allows you to integrate api docs with a gitbook located in `./docs/` 
+
+## Some notes:
+#### Typings for third party modules that do not bundle declaration files
+NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
+
+#### Instrumentalize Code
+npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
+
+#### Tests
+Any errors will be shown with reference to their originating source in TypeScript
+thanks to autogenerated source maps.