Skip to content

Commit 41d082c

Browse files
authored
docs: update examples in README (#195)
Signed-off-by: Matthew Peveler <[email protected]>
1 parent a2e1820 commit 41d082c

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To report issues for pdf-annotate.js, please file them under the [Submitty/Submi
1111

1212
## Objectives
1313

14-
- Provide a low level annotation layer for [pdf.js](https://github.com/mozilla/pdf.js).
14+
- Provide a low level annotation layer for [PDF.js](https://github.com/mozilla/pdf.js).
1515
- Optional high level UI for managing annotations.
1616
- Agnostic of backend, just supply your own `StoreAdapter` to fetch/store data.
1717
- Prescribe annotation format.
@@ -21,7 +21,6 @@ To report issues for pdf-annotate.js, please file them under the [Submitty/Submi
2121
```js
2222
import pdfjsLib from 'pdfjs-dist/build/pdf';
2323
import PDFJSAnnotate from 'pdfjs-annotate';
24-
import MyStoreAdapter from './myStoreAdapter';
2524

2625
const { UI } = PDFJSAnnotate;
2726
const VIEWER = document.getElementById('viewer');
@@ -33,7 +32,7 @@ const RENDER_OPTIONS = {
3332
};
3433

3534
pdfjsLib.workerSrc = 'pdf.worker.js';
36-
PDFJSAnnotate.setStoreAdapter(MyStoreAdapter);
35+
PDFJSAnnotate.setStoreAdapter(PDFJSAnnotate.LocalStoreAdapter);
3736

3837
pdfjsLib.getDocument(RENDER_OPTIONS.documentId).promise.then((pdf) => {
3938
RENDER_OPTIONS.pdfDocument = pdf;
@@ -42,7 +41,7 @@ pdfjsLib.getDocument(RENDER_OPTIONS.documentId).promise.then((pdf) => {
4241
});
4342
```
4443

45-
See more [examples](https://github.com/Submitty/pdf-annotate.js/tree/master/examples).
44+
See [/web](https://github.com/Submitty/pdf-annotate.js/tree/master/web) for an example web client for annotating PDFs.
4645

4746
## Documentation
4847

0 commit comments

Comments
 (0)