Skip to content

Commit

Permalink
update README, update version
Browse files Browse the repository at this point in the history
  • Loading branch information
SuttonKyle committed Jul 15, 2022
1 parent cfb1d43 commit 7b04f82
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,19 @@
![license](https://img.shields.io/npm/l/document-viewer-ts)
![npm](https://img.shields.io/npm/v/document-viewer-ts)
![npm bundle size](https://img.shields.io/bundlephobia/minzip/document-viewer-ts)

### Installation
Requires peer dependency `pdfjs-dist` at version `2.14.0` or higher:

```
npm install pdfjs-dist
```

Install the package:

```
npm install document-viewer-ts
```
### Example Usage
If using webpack, copy `PATH/TO/NODE_MODULES/pdfjs-dist/build/pdf.worker.min.js` to a local directory:

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "document-viewer-ts",
"version": "0.1.0",
"version": "0.1.2",
"description": "PDF and MS Doc viewer written in TypeScript for React and vanilla JavaScript",
"main": "dist/lib/index.js",
"module": "dist/es2015/index.js",
Expand Down

0 comments on commit 7b04f82

Please sign in to comment.