Skip to content
This repository was archived by the owner on Aug 9, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wuhanyumsft authored Aug 25, 2017
1 parent 082b0cc commit d814c99
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# type2docfx
A tool to convert json format output from TypeDoc to universal reference model for DocFx to consume.
# Type2DocFx
> A tool to convert json format output from TypeDoc to universal reference model for DocFx to consume.
## Installation
Type2DocFx runs on Node.js and is available as an NPM package.

```bash
$ npm install type2docfx --save-dev
```

## License

Licensed under the Apache License 2.0.

0 comments on commit d814c99

Please sign in to comment.