Update README.md

This commit is contained in:
Garrone Joseph 2021-02-28 10:50:10 +01:00 committed by GitHub
parent dd0591a4b0
commit 1cbcf5ddc1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -102,11 +102,12 @@ The publishing will actually be performed only if ``npm test`` passes.
<details>
<summary>Click to expand</summary>
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`.
</details>
## Enabling "Go to Definition" to redirect to the source ``.ts`` file