@univerjs-pro/bases-dashboard-ui 1.4.0 → 1.5.0

package/README.md

@@ -8,9 +8,9 @@
 
 ## Package Overview
 
-| Package | UMD global | CSS | Locales | Facade entry |
-| --- | --- | :---: | :---: | :---: |
-| `@univerjs-pro/bases-dashboard-ui` | `UniverProBasesDashboardUi` | Yes | Yes | No |
+| Package | UMD global | CSS | Locales | Facade entry | Worker entry |
+| --- | --- | :---: | :---: | :---: | :---: |
+| `@univerjs-pro/bases-dashboard-ui` | `UniverProBasesDashboardUi` | Yes | Yes | No | No |
 
 ## Installation
 
@@ -20,16 +20,14 @@ pnpm add @univerjs-pro/bases-dashboard-ui
 npm install @univerjs-pro/bases-dashboard-ui
 ```
 
-Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
-
 ## Usage
 
+Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
+
 Register `UniverBaseDashboardUIPlugin`, import `@univerjs-pro/bases-dashboard-ui/lib/index.css`, and merge the locale file for each language enabled by the host application.
 
 Dashboard charts are selected from Pivot Views. Dashboard widgets also support Base table filters, rich-text-backed text, uploaded images, and Formula Shapes.
 
-### Mobile
-
 Register `UniverMobileUIPlugin`, `UniverBasesMobileUIPlugin`, and `UniverChartMobileUIPlugin` before
 `UniverBaseDashboardUIPlugin`. The mobile plugins satisfy the shared dependency identities and select
 the mobile component registrations; using a mobile Chart Provider alone does not select the mobile plugin.
@@ -43,13 +41,19 @@ filter and value settings open nested drawers. Chart controls inherit the shared
 dropdown, and dialog components used by Sheets. Dashboard permission editing is hosted by the mobile
 `IDialogService` and is exposed only when the authorization provider supports the target.
 
+```ts
+import { UniverBaseDashboardUIPlugin } from '@univerjs-pro/bases-dashboard-ui';
+
+univer.registerPlugin(UniverBaseDashboardUIPlugin);
+```
+
 ## Integration Notes
 
-- Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
 - Import the package stylesheet once in your application.
 - Merge the locale resources for each language enabled by your application.
 
 ## Resources
 
-- [Documentation](https://docs.univer.ai/guides/pro)
+- [Documentation](https://docs.univer.ai)
 - [NPM package](https://npmjs.com/package/@univerjs-pro/bases-dashboard-ui)
+- [GitHub repository](https://github.com/dream-num/univer-pro)