pdfjs-viewer-element 1.0.4 → 2.0.1

package/README.md

@@ -2,7 +2,7 @@
 
 A web component for [PDF.js viewer](https://mozilla.github.io/pdf.js/web/viewer.html). See [demo](https://alekswebnet.github.io/pdfjs-viewer-element/index.html).
 
-⚠️ `pdfjs-viewer-element` uses PDF.js [prebuilt](https://github.com/mozilla/pdf.js/releases/download/v2.15.349/pdfjs-2.15.349-dist.zip), that includes the generic build of PDF.js and the viewer. To use the package you should **extract the prebuilt** file into a public directory of your project.
+⚠️ `pdfjs-viewer-element` uses PDF.js [prebuilt](https://github.com/mozilla/pdf.js/releases/download/v3.4.120/pdfjs-3.4.120-dist.zip), that includes the generic build of PDF.js and the viewer. To use the package you should **extract the prebuilt** files into some directory of your project. You may specify the path to this directory with `viewer-path` property (by default is '/pdfjs').
 
 ## Install
 ```
@@ -16,21 +16,21 @@ yarn add pdfjs-viewer-element
 ```
 
 ## Usage
-Import to your project as module:
+
+Extract the PDF.js prebuilt. See demo [example](https://github.com/alekswebnet/pdfjs-viewer-element/tree/master/public).
 
 ```javascript
 import 'pdfjs-viewer-element'
 ```
 
-Extract the PDF.js prebuilt. See [example](https://github.com/alekswebnet/pdfjs-viewer-element/tree/master/public).
-
-Use the element inside your template:
-
 ```javascript
-<pdfjs-viewer-element 
-  src="/pdfjs-2.15.349-dist/web/compressed.tracemonkey-pldi-09.pdf"
-  height="100vh">
-</pdfjs-viewer-element>
+<pdfjs-viewer-element src="/compressed.tracemonkey-pldi-09.pdf" viewer-path="/path-to-viewer"></pdfjs-viewer-element>
 ```
+
+## Properties
+
+`src` - path to pdf file.
+
+`viewer-path` - path to prebuilt directory (by default is '/pdfjs').
 ## License
 [MIT](http://opensource.org/licenses/MIT)