Skip to content

Commit 2b2bb8a

Browse files
authored
docs: fix some typos and add sponsors
1 parent de5c62d commit 2b2bb8a

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ The modernization steps:
2929
- migrate to TypeScript (giving us Types `d.ts`)
3030
- drop `Q` dependency (we simply use native `Promise`)
3131
- drop `Lodash` dependency (we now use native JS code)
32-
- replace `JSZip` dependency with [`fflate`](https://github.com/101arrowz/fflate) which has an ESM build offers better performance.
33-
- bump version to `v3.0.0` with a `major` release (_the original project version was in the `2.x` range._)
34-
- note: the changelog did not exists before `v3.0.0`
32+
- replace `JSZip` dependency with [`fflate`](https://github.com/101arrowz/fflate) which has an ESM build offers and better performance.
33+
- bump version to `v3.0.0` as a `major` release (_the original project version was in the `2.x` range._)
34+
- note that the changelog did not exists before `v3.0.0`
3535

3636
This modernization is providing a huge decrease in the final build size and is offering better performance 🚀
3737

@@ -43,7 +43,7 @@ npm install excel-builder-vanilla
4343

4444
The project offers 3 different bundle types, choose the best for your use case
4545
1. ESM: to `import from` (prefered)
46-
2. CJS: CommonJS to support old Node `require()`... might be removed in the future
46+
2. CJS: CommonJS to support old Node `require()` - will possibly be removed in the future
4747
3. IIFE: standalone script with `ExcelBuilder` available on the `window` object
4848

4949
```ts
@@ -55,6 +55,9 @@ const { createWorksheet } = require('excel-builder-vanilla');
5555

5656
// IIFE - CDN
5757
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/excel-builder.iife.js"></script>
58+
<script>
59+
const worksheet = ExcelBuilder.createWorksheet();
60+
</script>
5861
```
5962

6063
## Changelog
@@ -67,7 +70,7 @@ const { createWorksheet } = require('excel-builder-vanilla');
6770

6871
### Used by
6972

70-
This fork was created mostly to support Tree Shaking (ESM) and update all its dependencies. It is used by a few other Open Source libraries that I also maintain:
73+
This fork was created mostly to support Tree Shaking (ESM), provide TS Types and update all its dependencies. It is used by a few other Open Source libraries that I also maintain:
7174

7275
- [Angular-Slickgrid](https://github.com/ghiscoding/Angular-Slickgrid)
7376
- [Aurelia-Slickgrid](https://github.com/ghiscoding/aurelia-slickgrid)
@@ -88,7 +91,7 @@ If you wish to contribute to the project, please follow these steps:
8891

8992
1. clone the lib:
9093
- `git clone https://github.com/ghiscoding/excel-builder-vanilla`
91-
2. install with **pnpm** from the root:
94+
2. install it with **pnpm** from the project root:
9295
- `pnpm install` OR `npx pnpm install`
9396
3. run a full TypeScript build
9497
- `pnpm run build` OR `npx pnpm run build`
@@ -97,12 +100,21 @@ If you wish to contribute to the project, please follow these steps:
97100

98101
#### Pull Request Contribution
99102

100-
Before submitting a PR (pull request), please make sure that you followed these steps for your PR to succeed:
103+
Before submitting a PR (pull request), please make sure that you followed these steps for a better chance of a successfull PR:
101104

102-
1. make sure that you already ran `pnpm install`
105+
1. make sure that you have already executed `pnpm install`
103106
2. run the Biome lint npm script (or use step 4)
104107
- `pnpm run biome:lint:write`
105108
3. run the Biome code formatting npm script (or use step 4)
106109
- `pnpm run biome:format:write`
107-
4. run a full Build (this will also run Biome format, so you could skip step 2)
110+
4. run a full Build (this will also run Biome lint/format, so you could skip step 2)
108111
- `pnpm run build`
112+
113+
## Sponsors
114+
115+
<div>
116+
<img class="circle avatar-user" src="https://avatars.githubusercontent.com/u/48218815?s=52&amp;v=4" width="40" height="40" alt="@kevinburkett" />
117+
<a href="/kevinburkett" class="Link">
118+
<span class="wb-break-word ml-2">kevinburkett</span>
119+
</a>
120+
</div>

0 commit comments

Comments
 (0)