Skip to content

Commit 4719039

Browse files
authored
docs: improve project description
Updated README to clarify live demo and installation instructions.
1 parent b9289fb commit 4719039

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

packages/excel-builder-vanilla/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,27 @@
66

77
## Live Demo
88

9-
Available [**Live demo**](https://ghiscoding.github.io/excel-builder-vanilla/) which displays all available options/methods.
9+
Available [**Live demo**](https://ghiscoding.github.io/excel-builder-vanilla/) which displays a rough WYSIWYG (What You See Is What You Get) idea of all available options/methods.
1010

1111
## Installation
1212

1313
```sh
1414
npm install excel-builder-vanilla
1515
```
1616

17-
The project offers 2 different bundle types, choose the best for your use case
17+
The project offers 2 different bundle types, choose the best one depending on your use case:
1818
1. ESM: to `import from` (preferred)
1919
2. IIFE: standalone script with `ExcelBuilder` available on the `window` object
2020

21+
> [!NOTE]
22+
> ESM import is the preferred approach and IIFE might actually be removed in the future to lower download size even further.
23+
2124
```ts
2225
// ESM - npm install
2326
import { createWorksheet } from 'excel-builder-vanilla';
2427

2528
// IIFE - CDN
26-
<script src="https://cdn.jsdelivr.net/npm/excel-builder-vanilla@4.0.1/dist/excel-builder.iife.js"></script>
29+
<script src="https://cdn.jsdelivr.net/npm/excel-builder-vanilla@4.2.0/dist/excel-builder.iife.js"></script>
2730
<script>
2831
const worksheet = ExcelBuilder.createWorksheet();
2932
</script>

0 commit comments

Comments
 (0)