changed the package install instructions to install the .tgz package … (#1989)

* changed the package install instructions to install the .tgz package instead of symlinking the package - otherwise you'll get trouble with links on windows

* samples added

* added samples
This commit is contained in:
MBcom
2019-02-18 14:32:30 +01:00
committed by William Cheng
parent 534ff3607f
commit b4c36425c2
17 changed files with 48 additions and 20 deletions

View File

@@ -31,13 +31,15 @@ _without publishing (not recommended):_
```
{{#useNgPackagr}}
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
{{/useNgPackagr}}
{{^useNgPackagr}}
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/{{npmName}}-{{npmVersion}}.tgz --save
{{/useNgPackagr}}
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
{{#useNgPackagr}}

View File

@@ -18,8 +18,7 @@
"module": "dist/index.js",
"typings": "dist/index.d.ts",
"scripts": {
"build": "ngc",
"postinstall": "npm run build"
"build": "ngc && npm pack"
},
{{/useNgPackagr}}
"peerDependencies": {

View File

@@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE:

View File

@@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE:

View File

@@ -25,9 +25,11 @@ npm install @swagger/angular2-typescript-petstore@0.0.1 --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/@swagger/angular2-typescript-petstore-0.0.1.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE:

View File

@@ -12,8 +12,7 @@
"module": "dist/index.js",
"typings": "dist/index.d.ts",
"scripts": {
"build": "ngc",
"postinstall": "npm run build"
"build": "ngc && npm pack"
},
"peerDependencies": {
"@angular/core": "^2.0.0",

View File

@@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE:

View File

@@ -25,9 +25,11 @@ npm install @swagger/angular2-typescript-petstore@0.0.1 --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE/dist:

View File

@@ -25,9 +25,11 @@ npm install @swagger/angular2-typescript-petstore@0.0.1 --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE/dist:

View File

@@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE:

View File

@@ -25,9 +25,11 @@ npm install @swagger/typescript-angular-petstore@1.0.0 --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE/dist:

View File

@@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE:

View File

@@ -25,9 +25,11 @@ npm install @swagger/typescript-angular-petstore@1.0.0 --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE/dist:

View File

@@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE:

View File

@@ -25,9 +25,11 @@ npm install @swagger/typescript-angular-petstore@1.0.0 --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE/dist:

View File

@@ -25,9 +25,11 @@ npm install @ --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE --save
npm install PATH_TO_GENERATED_PACKAGE/-.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE:

View File

@@ -25,9 +25,11 @@ npm install @swagger/typescript-angular-petstore@1.0.0 --save
_without publishing (not recommended):_
```
npm install PATH_TO_GENERATED_PACKAGE/dist --save
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
```
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using `npm link`:_
In PATH_TO_GENERATED_PACKAGE/dist: