From c04d0ba667f7627af17816e7185919ade4eb0b51 Mon Sep 17 00:00:00 2001 From: Joseph Garrone Date: Sun, 28 May 2023 14:15:54 +0200 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a34c7c..a40764a 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,16 @@ https://user-images.githubusercontent.com/6702424/197344513-065246b9-8823-4894-a - ⚙️ ESlint and Prettier are automatically triggered against files staged for commit. Despite what [t3dotgg](https://github.com/t3dotgg) says, it's the correct way of doing it, that being said, this feature is optional and can be [disabled](https://github.com/garronej/ts-ci/blob/8da207622e51a248542cf013707198cd7cad1d09/README.md?plain=1#L87-L91) if desired. -# Release in CJS, ESM or both +# Release in CJS, ESM or both + +Contrary to what other guides or project starters may suggest, you don't necessarily need Vite/rollup to bundle your library, +nor do you need to fragment your modules into smaller, independently published units on NPM under the package/ directory for your module +to be tree-shakable (e.g., `@your-module/submodule1`, `@your-module/submodule2`). + +The reality is much simpler. The responsibility of bundling lies with the final application; your role involves merely +publishing `.js` files and types declaration `.d.ts` files, which are the output of `tsc`. + +And that's all there is to it! ## CJS only (default)