Skip to content

Commit

Permalink
remove features list from README
Browse files Browse the repository at this point in the history
Stop "advertising" features since while I don't mind people using pdfjs,
I don't really need it to grow in usage either. Especially the merging
of PDFs – even though it seem to work for some – lacks a lot of
features, so coming for pdfjs just for that might not be the best
motivation in the long time.
  • Loading branch information
rkusa committed Jul 31, 2023
1 parent c3af05f commit a0040ac
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 23 deletions.
24 changes: 1 addition & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/document.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
Expand All @@ -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:**
Expand All @@ -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:**
Expand Down
2 changes: 2 additions & 0 deletions docs/fragment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a0040ac

Please sign in to comment.