Skip to content

Commit 6d46dc7

Browse files
committed
Update readme
1 parent 46e51ed commit 6d46dc7

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@
33
</p>
44
<h1 align="center">pdfjs-viewer-element</h1>
55

6-
A custom element, based on [PDF.js default viewer](https://mozilla.github.io/pdf.js/web/viewer.html) and supported in all [major browsers](https://caniuse.com/custom-elementsv1), works with most used [JS frameworks](https://custom-elements-everywhere.com/).
7-
8-
See [examples](https://alekswebnet.github.io/pdfjs-viewer-element/#demo) of usage in Vue, React and Svelte or static HTML page.
6+
Probably the simplest integration of PDF.js viewer.
7+
The package provide a custom element, based on [PDF.js default viewer](https://mozilla.github.io/pdf.js/web/viewer.html), supported in all [major browsers](https://caniuse.com/custom-elementsv1), and works with most [JS frameworks](https://custom-elements-everywhere.com/).
98

109
⚠️ `pdfjs-viewer-element` requires PDF.js [prebuilt](http://mozilla.github.io/pdf.js/getting_started/), that includes the generic build of PDF.js and the viewer.
1110

@@ -20,7 +19,9 @@ The prebuilt comes with each PDF.js release. Supported releases:
2019

2120
To use the package you should download and **place the prebuilt** files to some directory of your project.
2221

23-
Then specify the path to this directory with `viewer-path` property (`/pdfjs` by default).
22+
Then specify the path to the directory with `viewer-path` property (`/pdfjs` by default).
23+
24+
See [examples](https://alekswebnet.github.io/pdfjs-viewer-element/#demo) of usage in Vue, React, Svelte or simple HTML page.
2425

2526
## Status
2627

@@ -45,6 +46,8 @@ Using module bundlers:
4546
npm install pdfjs-viewer-element
4647
# With yarn
4748
yarn add pdfjs-viewer-element
49+
# With pnpm
50+
pnpm add pdfjs-viewer-element
4851
```
4952

5053
```javascript
@@ -87,7 +90,7 @@ Using browser:
8790

8891
`viewer-extra-styles` - Add your CSS rules to viewer application
8992

90-
For more clarity, see the [Api docs page](https://alekswebnet.github.io/pdfjs-viewer-element/#api).
93+
Play with attributes on [Api docs page](https://alekswebnet.github.io/pdfjs-viewer-element/#api).
9194

9295
## Viewer CSS theme
9396

0 commit comments

Comments
 (0)