Skip to content

Commit

Permalink
updated references to the module
Browse files Browse the repository at this point in the history
  • Loading branch information
wehrstedt authored Jan 18, 2018
1 parent 2d3193c commit f3e48f4
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ This project is currently in development.
## Installation
You can install this module from npm:
```
$> npm install jsdoc-tsd
$> npm install @otris/jsdoc-tsd
```

## Usage
To use this module, simply specify this project as the template for your jsdoc output. To use this template from the command line, run
```
$> jsdoc -t node_modules/jsdoc-tsd -r .
$> jsdoc -t node_modules/@otris/jsdoc-tsd -r .
```

You can also add this template to your JSON configuration file:
```
{
"opts": {
"template": "./node_modules/jsdoc-tsd"
"template": "./node_modules/@otris/jsdoc-tsd"
}
}
```
Expand Down

0 comments on commit f3e48f4

Please sign in to comment.