Skip to content

Commit

Permalink
Update installation command in README depending on restify version
Browse files Browse the repository at this point in the history
  • Loading branch information
RemyJeancolas committed Jun 28, 2018
1 parent 12c80cd commit bd630f3
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ Create Swagger documentation page based on jsdoc

## Installation

### :warning: Check your restify version

**If you use a restify version prior to v7, you must use the following command:**
```bash
npm install restify-swagger-jsdoc@^1 --production
```
Else you can use the following command:
```bash
npm install restify-swagger-jsdoc --production
```
Expand Down Expand Up @@ -43,4 +50,4 @@ The swagger.json file is available at [http://localhost/docs/swagger/swagger.jso

## How to document the API

This module is based on [swagger-jsdoc](https://www.npmjs.com/package/swagger-jsdoc), so you can refer to this module's documentation to document your API.
This module is based on [swagger-jsdoc](https://www.npmjs.com/package/swagger-jsdoc), so you can refer to this module's documentation to document your API.

0 comments on commit bd630f3

Please sign in to comment.