snapshot of https://github.com/dream-num/univer.git (dev, 2026-09-16; blobs > 131072B omitted)

packages/protocol/README.md

@@ -0,0 +1,35 @@
+# @univerjs/protocol
+
+[![npm version](https://img.shields.io/npm/v/@univerjs/protocol?style=flat-square)](https://npmjs.com/package/@univerjs/protocol)
+[![license](https://img.shields.io/npm/l/@univerjs/protocol?style=flat-square)](https://npmjs.com/package/@univerjs/protocol)
+[![downloads](https://img.shields.io/npm/dm/@univerjs/protocol?style=flat-square)](https://npmjs.com/package/@univerjs/protocol)
+
+`@univerjs/protocol` contains shared protocol types, generated service interfaces, and data contracts used across Univer packages.
+
+## Package Overview
+
+| Package | UMD global | CSS | Locales | Facade entry |
+| --- | --- | :---: | :---: | :---: |
+| `@univerjs/protocol` | `UniverProtocol` | No | No | No |
+
+## Installation
+
+```sh
+pnpm add @univerjs/protocol
+# or
+npm install @univerjs/protocol
+```
+
+Keep all `@univerjs/*` packages on the same version.
+
+## Usage
+
+```ts
+import type { IWorkbookMeta } from '@univerjs/protocol';
+```
+
+## Resources
+
+- [Documentation](https://docs.univer.ai)
+- [NPM package](https://npmjs.com/package/@univerjs/protocol)
+- [GitHub repository](https://github.com/dream-num/univer)