This commit is contained in:
John Whitington 2022-08-16 14:53:19 +01:00
parent ebf338f069
commit 209b3b637c
1 changed files with 14 additions and 14 deletions

View File

@ -1,24 +1,18 @@
// CHAPTER -1: Introduction
/**
Use
---
For development server-side with node: cpdf.js (minified version cpdf.min.js)
cpdf.js can be used from both node and the browser.
Load with "const cpdf = require('cpdf.js')" if installed in npm, or "const cpdf
= require('./cpdf.js')" to load from current directory.
For development server-side with node: `cpdf.js` (minified version
`cpdf.min.js`) Load with `const cpdf = require('cpdf.js')` if installed in npm,
or `const cpdf = require('./cpdf.js')` to load from current directory.
For development client-side with the browser : cpdf.browser.js
(Minified version for deployment : cpdf.browser.min.js)
Load with <script src="cpdf.browser.js"></script> or similar.
Concurrency
-----------
cpdf.js is synchronous and non-re-entrant.
For development client-side with the browser : `cpdf.browser.js` (minified
version for deployment : `cpdf.browser.min.js`). Load with `<script
src="cpdf.browser.js"></script>` or similar.
Data types
@ -40,3 +34,9 @@ Errors
Any function may raise an exception, containing a string describing the problem.
Concurrency
-----------
cpdf.js is synchronous and non-re-entrant. In the browser, best used in a worker.
**/