Skip to content

Commit 18bcb7f

Browse files
authored
Update README.md
1 parent 4c695dc commit 18bcb7f

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Think of it as doing code-splitting 'last', rather than first.
1717

1818
Node 14+.
1919

20+
Kuto works best on large (>1mb) singular JS bundles 'bundled' to ESM — the tool works on a statement level, and an IIFE/webpack output is one giant statement.
21+
2022
## Usage
2123

2224
You can install via "kuto" and then run `npx kuto` to learn more.
@@ -52,15 +54,15 @@ By default, this looks in the output dir, but you can change it with a flag.
5254
For example:
5355

5456
```ts
55-
class A {}
56-
class B {}
57+
var A = class {};
58+
var B = class {};
5759

5860
// will be 'true' in `-d` mode
5961
new A() instanceof B;
6062
```
6163

6264
This is turned off by default, as it can be dangerous.
63-
Kuto will still dedup code where it is safe to do so!
65+
Kuto will still dedup other code where it is safe to do so!
6466

6567
- `-m <bytes>` only yeet code which is larger than this (default: `32`)
6668

@@ -89,7 +91,7 @@ This release process runs in three steps:
8991

9092
1. use esbuild to create one bundle (without minification)
9193
2. use kuto to split the bundle
92-
3. use esbuild on all resulting files purely to minify them
94+
3. use esbuild on all resulting files, _purely_ to minify
9395

9496
## Notes
9597

0 commit comments

Comments
 (0)