From a0040ac89fd2e81bb53d47e440ddf14de1555f82 Mon Sep 17 00:00:00 2001 From: Markus Ast Date: Mon, 31 Jul 2023 11:01:21 +0200 Subject: [PATCH] =?UTF-8?q?remove=20features=20list=20from=20README=20Stop?= =?UTF-8?q?=20"advertising"=20features=20since=20while=20I=20don't=20mind?= =?UTF-8?q?=20people=20using=20pdfjs,=20I=20don't=20really=20need=20it=20t?= =?UTF-8?q?o=20grow=20in=20usage=20either.=20Especially=20the=20merging=20?= =?UTF-8?q?of=20PDFs=20=E2=80=93=20even=20though=20it=20seem=20to=20work?= =?UTF-8?q?=20for=20some=20=E2=80=93=20lacks=20a=20lot=20of=20features,=20?= =?UTF-8?q?so=20coming=20for=20pdfjs=20just=20for=20that=20might=20not=20b?= =?UTF-8?q?e=20the=20best=20motivation=20in=20the=20long=20time.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 24 +----------------------- docs/document.md | 6 ++++++ docs/fragment.md | 2 ++ 3 files changed, 9 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 319117c6..5b4eaabf 100644 --- a/README.md +++ b/README.md @@ -4,34 +4,12 @@ A Portable Document Format (PDF) generation library targeting both the server- a [![NPM][npm]](https://npmjs.org/package/pdfjs) -[Documentation](docs) | [Playground](https://stackblitz.com/edit/js-hkxfhq?file=index.js) +[Documentation](docs) | [Changelog](https://github.com/rkusa/pdfjs/blob/master/CHANGELOG.md) | [Playground](https://stackblitz.com/edit/js-hkxfhq?file=index.js) | [Examples](https://github.com/rkusa/pdfjs/tree/master/test/pdfs) ```bash npm install pdfjs ``` ----------------- - -### Features - -- Text (with common formatting options) -- Images (JPEGs, other **PDFs** ¹) -- Tables (fixed layout, header row) -- Header & Footer -- AFM fonts && OTF font embedding (as CID fonts, i.e., support for fonts with large character sets) -- Add existing PDFs (merge them or add them as page templates) ¹ -- Document outline - -A lot of examples can be found in the [test folder](https://github.com/rkusa/pdfjs/tree/master/test/pdfs). - -If you are missing a feature, feel free to submit a PR or to ask for it. - -> ¹ Adding other PDFs as images or merging them together is still being considered a beta - proper error handling is adviced - -### History - -See [CHANGELOG](https://github.com/rkusa/pdfjs/blob/master/CHANGELOG.md). - ## MIT License [MIT](LICENSE) diff --git a/docs/document.md b/docs/document.md index 0d3e5489..f76a6be1 100644 --- a/docs/document.md +++ b/docs/document.md @@ -26,6 +26,8 @@ footer.text('This is a footer') ### .addPagesOf(external) +Note: please note that merging PDFs is still considered incomplete and has a couple of [outstanding issues](https://github.com/rkusa/pdfjs/issues?q=is%3Aissue+is%3Aopen+label%3Apdf-merge). + Add all pages of an external PDF into this document (aka merge an external document into this document). **Arguments:** @@ -42,6 +44,8 @@ doc.addPagesOf(ext) ### .addPageOf(page, external) +Note: please note that merging PDFs is still considered incomplete and has a couple of [outstanding issues](https://github.com/rkusa/pdfjs/issues?q=is%3Aissue+is%3Aopen+label%3Apdf-merge). + Add one specific page of an external PDF into this document (aka merge an external document into this document). **Arguments:** @@ -60,6 +64,8 @@ doc.addPageOf(3, ext) ### .setTemplate(external, [firstPageOnly]) +Note: please note that merging PDFs is still considered incomplete and has a couple of [outstanding issues](https://github.com/rkusa/pdfjs/issues?q=is%3Aissue+is%3Aopen+label%3Apdf-merge). + Use an external document as a page template (i.e. external PDF will be used as a starting point / as a background for all pages). **Arguments:** diff --git a/docs/fragment.md b/docs/fragment.md index 607c496d..7291f8a5 100644 --- a/docs/fragment.md +++ b/docs/fragment.md @@ -97,6 +97,8 @@ row.cell('Cell 2') Add an image to the document. +Supported formats: JPEGs, other PDFs + **Arguments:** - **img** - a `pdf.Image` object of the image