@univerjs-pro/collaboration 0.21.1 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,17 +1,36 @@
1
1
  # @univerjs-pro/collaboration
2
2
 
3
- ## Introduction
3
+ [![npm version](https://img.shields.io/npm/v/@univerjs-pro/collaboration?style=flat-square)](https://npmjs.com/package/@univerjs-pro/collaboration)
4
+ [![downloads](https://img.shields.io/npm/dm/@univerjs-pro/collaboration?style=flat-square)](https://npmjs.com/package/@univerjs-pro/collaboration)
4
5
 
5
- Univer collaboration plugin. It brings online collaboration to your Univer application.
6
+ `@univerjs-pro/collaboration` provides shared collaboration models, resources, and services for Univer Pro.
7
+
8
+ ## Package Overview
9
+
10
+ | Package | UMD global | CSS | Locales | Facade entry |
11
+ | --- | --- | :---: | :---: | :---: |
12
+ | `@univerjs-pro/collaboration` | `UniverProCollaboration` | No | No | No |
13
+
14
+ ## Installation
15
+
16
+ ```sh
17
+ pnpm add @univerjs-pro/collaboration
18
+ # or
19
+ npm install @univerjs-pro/collaboration
20
+ ```
21
+
22
+ Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
6
23
 
7
24
  ## Usage
8
25
 
9
- ### Installation
26
+ ```ts
27
+ import { UniverCollaborationPlugin } from '@univerjs-pro/collaboration';
10
28
 
11
- ```shell
12
- npm i @univerjs-pro/collaboration
29
+ univer.registerPlugin(UniverCollaborationPlugin);
13
30
  ```
14
31
 
15
- ### API
32
+ ## Resources
33
+
34
+ - [Documentation](https://docs.univer.ai/guides/pro)
35
+ - [NPM package](https://npmjs.com/package/@univerjs-pro/collaboration)
16
36
 
17
- Check [Univer](https://github.com/dream-num/univer/)