docs: Readme updates

typedoc2md · May 15, 2021 · a572018 · a572018
1 parent 83e588f
commit a572018
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/packages/typedoc-github-wiki-theme/README.md b/packages/typedoc-github-wiki-theme/README.md
@@ -20,7 +20,7 @@ npm install typedoc typedoc-plugin-markdown typedoc-github-wiki-theme --save-dev
 ### Usage
 
 ```bash
-$ npx typedoc --plugin typedoc-plugin-markdown --theme ./node_modules/typedoc-github-wiki-theme/dist [args]
+$ npx typedoc --theme ./node_modules/typedoc-github-wiki-theme/dist [args]
 ```
 
 ## License

diff --git a/packages/typedoc-plugin-markdown/README.md b/packages/typedoc-plugin-markdown/README.md
@@ -1,6 +1,6 @@
 # typedoc-plugin-markdown
 
-A plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that renders documentation as Markdown.
+A plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that renders TypeScript API documentation as Markdown.
 
 [![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg)](https://www.npmjs.com/package/typedoc-plugin-markdown)
 [![Build Status](https://travis-ci.org/tgreyuk/typedoc-plugin-markdown.svg?branch=master)](https://travis-ci.org/tgreyuk/typedoc-plugin-markdown)
@@ -9,6 +9,8 @@ A plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that renders docum
 
 The plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options.
 
+Useful if documentation is required to be included in project README files, Wikis and static site generators.
+
 ## Installation
 
 ```bash
@@ -17,14 +19,16 @@ npm install --save-dev typedoc typedoc-plugin-markdown
 
 ## Usage
 
+Usage is the same as documented at [TypeDoc](https://typedoc.org/guides/installation/#command-line-interface).
+
 ```bash
-$ npx typedoc ...options
+typedoc --out docs src/index.ts
 ```
 
-### Note:
+**Note:**
 
 - If using with the default HTML theme or other themes, use `--plugin none` to switch the plugin off.
-- The plugin needs to be executed from the same location as TypeDoc. If running directly from command prompt make sure to use `npx`.
+- The plugin should be executed in the same location as TypeDoc. Use `npx` if running command directly in shell.
 
 ## Options