Skip to content

Commit 95c293e

Browse files
committed
docs: improve README.md
1 parent f1f3e43 commit 95c293e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ Automatically update your codebase to add migrations, entities and subscribers t
55
## Installation
66
1. Install dependencies
77
```bash
8-
npm install --save typeorm typescript ts-node
8+
npm install --save typeorm typescript
99
```
1010

1111
2. Install `typeorm-codebase-sync`
1212
```bash
1313
npm install --save typeorm-codebase-sync
1414
```
1515

16-
3. Add a script to `package.json`
16+
3. Add `typeorm-sync` script to `package.json`
1717
```bash
1818
npm set-script "typeorm-sync" "typeorm-codebase-sync addReferences --dataSource ./src/db/data-source.ts --migrations ./src/db/migrations --entities ./src/db/entities --subscribers ./src/db/subscribers"
1919
```
@@ -24,7 +24,7 @@ npm set-script "posttypeorm" "npm run typeorm-sync"
2424
```
2525

2626
> Given that your `package.json` contains a script called `typeorm`,
27-
> After you run `npm run typeorm -- <params>`, the script `typeorm-sync` will automatically get called.
27+
> after each time you run `npm run typeorm -- <params>`, the `typeorm-sync` script will automatically run
2828
2929
## Documentation
3030
### `addReferences` command
@@ -41,5 +41,5 @@ Files:
4141
4242
Options:
4343
-h, --help Show help [boolean]
44-
-v, --version Show version number [boolean] [boolean]
44+
-v, --version Show version number [boolean]
4545
```

0 commit comments

Comments
 (0)