Mercurial > hgrepos > Python2 > PyMuPDF

diff mupdf-source/platform/wasm/README.md @ 2:b50eed0cc0ef upstream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mupdf-source/platform/wasm/README.md	Mon Sep 15 11:43:07 2025 +0200
@@ -0,0 +1,43 @@
+# MuPDF.js
+
+Welcome to the official MuPDF.js library from [Artifex](https://artifex.com).
+
+Use [MuPDF](https://mupdf.com) in your JavaScript and TypeScript projects!
+
+This library is powered by WebAssembly and can be used in all the usual
+JavaScript environments: Node, Bun, Firefox, Safari, Chrome, etc.
+
+## License
+
+MuPDF.js is available under Open Source
+[AGPL](https://www.gnu.org/licenses/agpl-3.0.html) and commercial license
+agreements.
+
+> If you cannot meet the requirements of the AGPL, please contact
+> [Artifex](https://artifex.com/contact/mupdf-inquiry.php) regarding a
+> commercial license.
+
+## Installation
+
+	npm install mupdf
+
+## Usage
+
+The module is only available as an ESM module!
+
+	import mupdf from "mupdf"
+
+	var doc = mupdf.Document.openDocument("test.pdf")
+	console.log(doc.countPages())
+
+Check out the [example projects](examples/) to help you get started.
+
+## Documentation
+
+- [MuPDF.js Reference](https://mupdf.readthedocs.io/en/latest/reference/javascript/)
+- [Getting Started & Examples](https://mupdfjs.readthedocs.io/en/latest/)
+
+## Contact
+
+Join the Discord at [#mupdf.js](https://discord.gg/zpyAHM7XtF) to chat with the
+developers directly.