Skip to content

Commit 64e06c7

Browse files
committed
Add a README
1 parent b9c74b5 commit 64e06c7

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# MongoDB Data Modeling Workshop PDF Viewer
2+
3+
This repository hosts a PDF.js-based viewer for the **MongoDB Data Modeling Workshop** worksheet. You can edit the worksheet directly in your browser without downloading any files.
4+
5+
## Files
6+
7+
- `worksheet.pdf` – The MongoDB Data Modeling Workshop worksheet.
8+
- `web/` – PDF.js viewer files (`viewer.html`, `viewer.js`, `viewer.css`, etc.).
9+
- `build/` – PDF.js library files (`pdf.js`, `pdf.worker.js`).
10+
11+
## Usage
12+
13+
1. Clone this repository.
14+
15+
2. Serve with the `http-serve` or another HTTP server:
16+
```
17+
npx http-serve .
18+
```
19+
20+
3. Open http://127.0.0.1:8080/web/viewer.
21+
22+
4. The editable worksheet will load in the viewer.
23+
24+
## License
25+
26+
- **PDF.js** is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
27+
- **This repository** (HTML, CSS, custom files, and the worksheet) is also licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
28+
29+
## Disclaimer
30+
31+
Use at your own risk; not a supported MongoDB product

0 commit comments

Comments
 (0)