Skip to content

Commit 63c382e

Browse files
committed
Improve readme
1 parent d191f57 commit 63c382e

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# pdfjs-viewer-element
22

3-
A web component for viewing pdf files in the browser. The package is based on [PDF.js default viewer](https://mozilla.github.io/pdf.js/web/viewer.html) build and works with any framework.
3+
A custom element, based on [PDF.js default viewer](https://mozilla.github.io/pdf.js/web/viewer.html). Works in all [major browsers](https://caniuse.com/custom-elementsv1) and with most [JS frameworks](https://custom-elements-everywhere.com/). See [examples](https://alekswebnet.github.io/pdfjs-viewer-element/#demo) of usage in the different frameworks.
44

5-
⚠️ `pdfjs-viewer-element` uses PDF.js [prebuilt](http://mozilla.github.io/pdf.js/getting_started/), that includes the generic build of PDF.js and the viewer. To use the package you should download and **place the prebuilt** files to some directory of your project. Then specify the path to this directory with `viewer-path` property (`/pdfjs` by default).
5+
⚠️ `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. To use the package you should download and **place the prebuilt** files to some directory of your project. Then specify the path to this directory with `viewer-path` property (`/pdfjs` by default).
66

77
## Status
88

@@ -49,9 +49,9 @@ Using browser:
4949

5050
`src` - Path to pdf file
5151

52-
`viewer-path` - Path to PDF.js prebuilt
52+
`viewer-path` - Path to PDF.js [prebuilt](http://mozilla.github.io/pdf.js/getting_started/)
5353

54-
`locale` - Language of the interface, see [all l10n files](https://github.com/mozilla/pdf.js/tree/master/l10n)
54+
`locale` - Specifies which language to use in the viewer UI. For a list of the available locales, see [all l10n files](https://github.com/mozilla/pdf.js/tree/master/l10n)
5555

5656
`text-layer` - Text layer, that is used for text selection
5757

@@ -68,6 +68,4 @@ Using browser:
6868
For more clarity, see the [Api docs page](https://alekswebnet.github.io/pdfjs-viewer-element/#api).
6969

7070
## License
71-
For this package - [MIT](http://opensource.org/licenses/MIT).
72-
73-
For the `pdf.js` library - https://github.com/mozilla/pdf.js/blob/master/LICENSE.
71+
[MIT](http://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)