Skip to content

Commit f5b3f44

Browse files
authored
docs: improve readme documentation
1 parent 75da724 commit f5b3f44

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616

1717
## Description
1818

19-
This lib allows you to build and write an Excel file dynamically, it does **not** include any reader capabilities making the library super lightweight for its main goal of strictly exporting data to Excel.
19+
This libray allows you to build and write an Excel file dynamically, it does **not** include any reader capabilities making the library super lightweight for its main goal of strictly exporting data to Excel.
2020

2121
### Creator
2222

23-
This project was originally created by Stephen Liberty, `excel-builder-vanilla` is a fork of the original [excel-builder.js](https://github.com/stephenliberty/excel-builder.js) project that Stephen created. Thanks to him for this great library.
23+
This project was originally created by Stephen Liberty and `excel-builder-vanilla` is a fork of its original [excel-builder.js](https://github.com/stephenliberty/excel-builder.js) project that Stephen created. Thanks to him for this great library.
2424

2525
### Comparison to similar libraries
2626

@@ -30,7 +30,7 @@ Excel-builder-vanilla is at the minimum 8x times smaller than the most popular l
3030

3131
## Live Demo
3232

33-
Visit the [**Live demo**](https://ghiscoding.github.io/excel-builder-vanilla/) to get started and see all available options and methods that the library offers (all the demos are WYSIWYG (what you is what you'll get, UI vs Export)).<br>
33+
Visit the [**Live demo**](https://ghiscoding.github.io/excel-builder-vanilla/) to get started and see all available options and methods that the library offers (all the demos are WYSIWYG (what you is what you'll get in the Excel Export)).<br>
3434
You can also take a look at the "[Used by](#used-by)" section below to see real world applications taking advantage of this library.
3535

3636
## License
@@ -61,7 +61,7 @@ import { createWorksheet } from 'excel-builder-vanilla';
6161
```
6262

6363
### CSP (Content Security Policy)
64-
Please note that since we use `fflate` (which creates and compresses the Excel file before sending it to the browser), you might get some CSP errors because of its use of Web Workers. For that reason, you might need to adjust your CSP rules by adding `worker-src 'self' blob:;`
64+
Please note that since the library uses `fflate` (which creates and compresses the Excel file before sending it to the browser), you might get some CSP errors because of its use of Web Workers. For that reason, you might need to adjust your CSP rules by adding `worker-src 'self' blob:;`
6565

6666
```html
6767
<meta http-equiv="Content-Security-Policy"
@@ -89,7 +89,7 @@ downloadExcelFile(artistWorkbook, 'Artist WB.xlsx');
8989
```
9090

9191
## Project History
92-
Excel-Builder-Vanilla is a fork of the popular [excel-builder.js](https://github.com/stephenliberty/excel-builder.js) project (thanks to @stephenliberty for this great library). The main goal of creating this fork was to modernize the project by removing old dependencies that are no longer necessary and also replace `JSZip` by `fflate` which provides an ESM build and is indirectly giving us better Tree Shaking. The other goal was also to provide an ESM build
92+
Excel-Builder-Vanilla is a fork of the popular [excel-builder.js](https://github.com/stephenliberty/excel-builder.js) project (thanks to @stephenliberty for this great library). The main goal to create this fork was to modernize the project by removing old dependencies that are no longer necessary and also replace `JSZip` with `fflate` which provides an ESM build and is indirectly giving us better Tree Shaking. The other goal was also to provide an ESM build
9393

9494
The modernization steps:
9595
- migrate to TypeScript (which is giving us TS Types `d.ts`)
@@ -101,11 +101,11 @@ The modernization steps:
101101
- v4.x is now ESM-Only
102102
- new Streaming API for large datasets
103103

104-
The project now requires only 1 small dependency which is [fflate](https://github.com/101arrowz/fflate).
104+
The project now requires only 1 small external dependency which is [fflate](https://github.com/101arrowz/fflate).
105105

106106
### Summary
107107

108-
This modernization is providing a huge decrease in the final build size, with only 1 dependency, and also offers better performance 🚀
108+
This modernization provides a huge decrease in the final build size, with only 1 dependency, and also offers better performance 🚀
109109

110110
### Used by
111111

@@ -178,8 +178,4 @@ Before submitting a PR (pull request), please make sure that you followed these
178178
<span>
179179
<a href="https://github.com/gibson552" class="Link" title="gibson552" target="_blank"><img src="https://avatars.githubusercontent.com/u/84058359?s=52&v=4" class="avatar avatar-user" width="50" height="50" valign="middle" /></a>
180180
</span>
181-
&nbsp;
182-
<span>
183-
<a href="https://github.com/web-ascender" class="Link" title="Web Ascender" target="_blank"><img src="https://avatars.githubusercontent.com/u/832747?s=200&v=4" width="50" height="50" valign="middle" /></a>
184-
</span>
185181
</div>

0 commit comments

Comments
 (0)