Skip to content

Commit bc71b6e

Browse files
author
Matt Morgan
committed
update README installation instructions
1 parent 31839a8 commit bc71b6e

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ You can use routing-controllers with [express.js][1] or [koa.js][2].
7373

7474
1. Install module:
7575

76-
`npm install routing-controllers --save`
76+
`npm install routing-controllers`
7777

7878
2. `reflect-metadata` shim is required:
7979

80-
`npm install reflect-metadata --save`
80+
`npm install reflect-metadata`
8181

8282
and make sure to import it before you use routing-controllers:
8383

@@ -89,21 +89,27 @@ You can use routing-controllers with [express.js][1] or [koa.js][2].
8989

9090
**a. If you want to use routing-controllers with *express.js*, then install it and all required dependencies:**
9191

92-
`npm install express body-parser multer --save`
92+
`npm install express body-parser multer`
9393

9494
Optionally you can also install their typings:
9595

96-
`npm install @types/express @types/body-parser @types/multer --save`
96+
`npm install -D @types/express @types/body-parser @types/multer`
9797

9898
**b. If you want to use routing-controllers with *koa 2*, then install it and all required dependencies:**
9999

100-
`npm install koa koa-router koa-bodyparser koa-multer --save`
100+
`npm install koa koa-router koa-bodyparser koa-multer`
101101

102102
Optionally you can also install their typings:
103103

104-
`npm install @types/koa @types/koa-router @types/koa-bodyparser --save`
104+
`npm install -D @types/koa @types/koa-router @types/koa-bodyparser`
105105

106-
4. Its important to set these options in `tsconfig.json` file of your project:
106+
4. Install peer dependencies:
107+
108+
`npm install class-transformer class-validator`
109+
110+
In prior versions, these were direct dependencies, but now they are peer dependencies so you can choose when to upgrade and accept breaking changes.
111+
112+
5. Its important to set these options in `tsconfig.json` file of your project:
107113

108114
```json
109115
{

0 commit comments

Comments
 (0)