From 1cbcf5ddc15a58a1d1c5b04764f45fc5d9477615 Mon Sep 17 00:00:00 2001 From: Garrone Joseph Date: Sun, 28 Feb 2021 10:50:10 +0100 Subject: [PATCH] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5335e9c..3edc554 100644 --- a/README.md +++ b/README.md @@ -102,11 +102,12 @@ The publishing will actually be performed only if ``npm test`` passes.
Click to expand -All your source files must remain inside the ``src`` dir, you can change how things are organized inside the source directory -but don't forget to update your ``package.json`` ``main``, ``type`` and ``files`` fields and ``tsconfig.esm.json`` ``include`` field when appropriate. - -- If you add a new directory in `src/`: Add it to `files` in `package.json` or it wont be in you npm bundle. +You can freelly change how things are organized inside the `src/` directory but be mindfull: +- If you add a new directory in `src/`: Add it to `files` in `package.json` or it wont be included in you npm bundle. +- If you change the entry point of your module (default `src/index.ts`) update `include` in the `tsconfig.esm.json` as well as `main` and `type` + in `package.json`. +
## Enabling "Go to Definition" to redirect to the source ``.ts`` file