Skip to content

Commit 56938b9

Browse files
committed
docs: update README.md with info for the libs tag
1 parent b9115a4 commit 56938b9

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
TypeScript support for NativeScript projects
22
=======================================
33

4-
How to use
4+
# How to use
55
----------
66
```
7-
$ tns install typescript
7+
$ npm install -D nativescript-dev-typescript
88
```
99

1010
The above command installs this module and installs the necessary hooks. TypeScript compilation happens when the project is prepared for build. A file named `tsconfig.json` that specifies compilation options will be created in the project folder and should be committed to source control.
11+
12+
# Note for plugins
13+
----------
14+
```
15+
$ npm install -D nativescript-dev-typescript@libs
16+
```
17+
18+
When developing NativeScript plugins, you should install the 'libs' tag of the nativescript-dev-typescript plugin. This will skip adding 'paths' mappings for 'tns-core-modules' in the 'tsconfig.json', because of this Angular compiler [issue](https://github.com/angular/angular-cli/issues/5618).

0 commit comments

Comments
 (0)