From 63da2630bf20f28b9206f1a4dfd52bbf0393c8c1 Mon Sep 17 00:00:00 2001 From: Sergei Dorogin Date: Thu, 17 Aug 2017 13:41:13 +0300 Subject: [PATCH] Update README Added clarification for npm usage and `module: "amd"` --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 86559d9..49fa0ef 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,15 @@ or in your tsconfig.json: } ``` +#### For npm users +You don't need to do anything if `moduleResolution` option is `"node"`. If it's not (e.g. it implicitly equals to `"classic"` when `module` option is `"amd"`) then you will need to add a `paths` mapping: +```json + "baseUrl": ".", // This must be specified if "paths" is. + "paths": { + "tslib": ["node_modules/tslib/tslib.d.ts"] // This mapping is relative to "baseUrl" + } +``` + #### For bower and JSPM users You will need to add a `paths` mapping for `tslib`, e.g. For Bower users: