docs: add readme

[skip ci]

Author: northword

README.md

@@ -0,0 +1,60 @@
+# 📄 zotero-pdfjs-types
+
+[![Build Status](https://github.com/zotero-plugin-dev/zotero-pdfjs-types/actions/workflows/update-types.yml/badge.svg)](https://github.com/zotero-plugin-dev/zotero-pdfjs-types/actions/workflows/update-types.yml)
+[![Last Update](https://img.shields.io/github/last-commit/zotero-plugin-dev/zotero-pdfjs-types?label=Types%20last%20update&color=blue)](https://github.com/zotero-plugin-dev/zotero-pdfjs-types)
+[![Last Update (pdf.js)](https://img.shields.io/github/last-commit/zotero/pdf.js?label=PDF.js%20last%20update&color=blue)](https://github.com/zotero/pdf.js)
+![Repo Size](https://img.shields.io/github/repo-size/zotero-plugin-dev/zotero-pdfjs-types)
+[![Types Included in zotero-types](https://img.shields.io/badge/zotero--types-integrated-success)](https://github.com/windingwind/zotero-types)
+
+**Type definitions for Zotero’s fork of PDF.js**, generated automatically from the latest Zotero [`pdf.js`](https://github.com/zotero/pdf.js) source.
+
+This repository provides up-to-date TypeScript types for plugin developers targeting the Zotero PDF reader environment.
+
+## 🧩 Background
+
+Zotero maintains its own fork of [`pdf.js`](https://github.com/mozilla/pdf.js), with custom modifications for its built-in PDF reader.
+
+Since this fork diverges from upstream, the standard `pdfjs-dist` package no longer reflects Zotero’s implementation.
+
+To enable **TypeScript development** for Zotero plugins interacting with the internal PDF viewer, this project:
+
+- Pulls the **latest Zotero `pdf.js` source** every day
+- **Builds it** using the official Gulp pipeline (`npx gulp dist`)
+- **Extracts and commits the generated type definitions** to this repository
+
+## 📦 Usage
+
+> [!TIP]
+> The `zotero-types` package automatically includes this repository, so you typically **don’t need to install this directly**.
+
+```bash
+pnpm add -D zotero-types
+```
+
+If you want to use it independently:
+
+```bash
+pnpm add -D github:zotero-plugin-dev/zotero-pdfjs-types#main
+```
+
+## 🧭 Relationship to Other Projects
+
+- **[`zotero/pdf.js`](https://github.com/zotero/pdf.js)** — the official Zotero fork of Mozilla PDF.js
+- **[`zotero-types`](https://github.com/windingwind/zotero-types)** — the comprehensive Zotero TypeScript type package that integrates this repository
+
+```mermaid
+graph TD
+    A["mozilla/pdf.js (Upstream Project)"] -->|Forked by Zotero| B["zotero/pdf.js (Customized Fork)"]
+    B -->|Daily sync & build types| C["zotero-pdfjs-types (Generated TS Types)"]
+    C -->|Integrated into| D["zotero-types (Full Zotero Type Package)"]
+    D -->|Used by| E["Zotero Plugin Developers (Type-safe Plugins)"]
+```
+
+## 🧑‍💻 For Contributors
+
+> [!NOTE]
+> Do not manually edit files under `types/`. They are automatically generated and will be overwritten.
+
+## 🪪 License
+
+Apache 2.0 License.