docs: document npm run pack (#8349)

This commit is contained in:
Joe Flateau 2021-11-10 09:40:40 -05:00 committed by GitHub
parent 3f981975d4
commit d0393197dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -81,6 +81,15 @@ This command will generate you a distribution package in the `build/package` dir
You can link (or simply copy/paste) this directory into your project and test TypeORM there
(but make sure to keep all node_modules required by TypeORM).
To build the distribution package of TypeORM packed into a `.tgz`, run:
```shell
npm run pack
```
This command will generate you a distribution package tar in the `build` directory (`build/typeorm-x.x.x.tgz`).
You can copy this tar into your project and run `npm install ./typeorm-x.x.x.tgz` to bundle your build of TypeORM in your project.
## Running Tests Locally
It would be greatly appreciated if PRs that change code come with appropriate tests.