Merge pull request #33 from SimplrJS/dev

v0.1.0

Author: Martynas Žilinskas

common/config/rush/npm-shrinkwrap.json

@@ -7,6 +7,6 @@
         "**/.hg": true,
         "**/CVS": true,
         "**/.DS_Store": true,
-        "tests/**/__tests__/**/*.test.ts": true
+        "tests/cases/__tests__/**/*.test.ts": true
     }
 }

packages/ts-docs-gen/.vscode/settings.json

@@ -1 +1,45 @@
-# ts-docs-gen
+# ts-docs-gen
+
+_Readme is WIP._
+
+Generates documentation from TypeScript files.
+
+## Get started 
+```sh
+npm install ts-docs-gen -g
+```
+
+## CLI usage
+```sh
+ts-docs-gen -h
+```
+
+### Examples
+
+#### Without config
+
+If you want to use `ts-docs-gen` without config file, `entryFile` flag is required.
+```
+ts-docs-gen --entryFile ./src/index.ts
+```
+
+Multiple entry files:
+```
+ts-docs-gen --entryFile ./src/index.ts --entryFile ./src/internal.ts
+```
+
+#### With config
+
+```
+ts-docs-gen --config ./docs-gen.json
+```
+
+## Configuration
+JSON config properties and CLI flags.
+
+| Property    | CLI Flag          | Required   | Type     | Default                   | Description                                |
+|-------------|-------------------|------------|----------|---------------------------|--------------------------------------------|
+| `entryFile` | `--entryFile`     | _required_ | string[] |                           | TypeScript project entry files.            |
+| `project`   | `--project`, `-p` | _optional_ | string   | Current working directory | Full path to TypeScript project directory. |
+| `output`    | `--output`, `-o`  | _optional_ | string   | ./docs/api/               | Documentation output directory.            |
+| `plugin`    | `--plugin`        | _optional_ | string[] |                           | Packagename or path to plugin.             |

packages/ts-docs-gen/README.md

@@ -0,0 +1,3 @@
+{
+    "entryFile": "./src/index.ts"
+}