@broadpaper/forme 0.2.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Browserless PDF generation for BroadPaper, via the Forme WebAssembly engine. The recommended backend.
8
8
 
9
- Part of [**BroadPaper**](https://www.broadpaper.com) — an embeddable visual report designer and PDF renderer.
9
+ Part of [**BroadPaper**](https://www.broadpaper.com/developers/) — an embeddable visual report designer and PDF renderer.
10
10
  Your users design the report in your application; BroadPaper owns the layout, the branding,
11
11
  the pagination and the output.
12
12
 
@@ -21,26 +21,29 @@ engine and nothing else to install. That is what makes BroadPaper deployable in
21
21
  that has no browser in it, which is most of the containers a report renderer belongs in.
22
22
 
23
23
  ```ts
24
- import { renderPdf } from "@broadpaper/forme";
24
+ import { createRegistry } from "@broadpaper/blocks";
25
+ import { renderPdfPaginated } from "@broadpaper/forme";
25
26
 
26
- const { pdf, pages } = await renderPdf({ template, data });
27
+ const { pdf, pages } = await renderPdfPaginated({ template, data, registry: createRegistry() });
27
28
  ```
28
29
 
29
- Text is selectable, fonts are embedded, and output is byte-for-byte deterministic for
30
+ Text is selectable, the fonts you supply are embedded, and output is byte-for-byte deterministic for
30
31
  identical input — so a document regenerated a year later is the same file, and a diff of two
31
32
  renders shows what actually changed.
32
33
 
33
34
  ## Licensing
34
35
 
35
36
  BroadPaper is **free to evaluate, with no trial clock and nothing behind a feature gate**.
36
- Install it, use every feature, run it against your real data, in production if you like.
37
+ Install it, use every feature and evaluate it against your real data for as long as you like.
38
+ Production use needs a licence.
37
39
 
38
- The only difference without a licence is that generated PDFs carry an evaluation mark. A
39
- licence removes it — that is the entire commercial mechanism. No seats, no activation, no
40
- machine binding, no telemetry, and no call home at any point.
40
+ In the software, the only difference without a licence is that generated PDFs carry an
41
+ evaluation mark, and a licence removes it. Contractually, the licence is also what permits
42
+ production use. No seats, no activation, no machine binding, no telemetry, and no call home at
43
+ any point.
41
44
 
42
45
  - [How licensing works](https://www.broadpaper.com/docs/guide/licensing/)
43
- - [Pricing](https://www.broadpaper.com/pricing/)
46
+ - [Pricing](https://www.broadpaper.com/developers/pricing/)
44
47
  - [Licence agreement](https://www.broadpaper.com/legal/terms/)
45
48
 
46
49
  ## Documentation