Skip to content

Commit f794052

Browse files
committed
describe different types of output files in readme
1 parent 5211ec9 commit f794052

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,17 @@ Or always get latest version via [unpkg](https://unpkg.com/#/)
3838
<script src="https://unpkg.com/jspdf@latest/dist/jspdf.min.js"></script>
3939
```
4040

41+
The `dist` folder of this package contains different kinds of files:
42+
43+
- **jspdf.es.\*.js**: Modern ES2015 module format.
44+
- **jspdf.node.\*.js**: For running in Node. Uses file operations for loading/saving files instead of browser APIs.
45+
- **jspdf.umd.\*.js**: UMD module format. For AMD or script-tag loading.
46+
- **polyfills\*.js**: Required polyfills for older browsers like Internet Explorer. The es variant simply imports all
47+
required polyfills from `core-js`, the umd variant is self-contained.
48+
49+
Usually it is not necessary to specify the exact file in the import statement. Build tools or Node automatically figure
50+
out the right file, so importing "jspdf" is enough.
51+
4152
## Usage
4253

4354
Then you're ready to start making your document:

0 commit comments

Comments
 (0)