Add note in docs about external config files (#733)

TypeStrong · Feb 28, 2018 · 8b07efb · 8b07efb
1 parent 847e5e4
commit 8b07efb
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -280,6 +280,9 @@ You may provide
 * a relative path to the configuration file. It will be resolved relative to the respective `.ts` entry file.
 * an absolute path to the configuration file.
 
+Please note, that if the configuration file is outside of your project directory, you might need to set the `context` option to avoid TypeScript issues (like TS18003).
+In this case the `configFile` should point to the `tsconfig.json` and `context` to the project root.
+
 #### colors _(boolean) (default=true)_
 
 If `false`, disables built-in colors in logger messages.