Skip to content

Commit 52ce370

Browse files
committed
feat(README): add section on TypeScript config
1 parent c59a08d commit 52ce370

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,13 @@ $ npm run build
8484

8585
to automatically create all `*.js`, `*.d.ts` and `*.metadata.json` files in the `dist/` directory.
8686

87+
## TypeScript config
88+
89+
The generates creates 2 TypeScript config files:
90+
91+
- `tsconfig.json` is used to configure your editor during development and is not used for building your library
92+
- `src/tsconfig.es5.json` is used by the Angular compiler to build the files in the `dist` directory when you run `npm run build`
93+
8794
## Linting your code
8895

8996
Everything comes pre-configured with tslint and codelyzer support. To lint your code:

0 commit comments

Comments
 (0)