@univerjs-pro/sheets-chart-ui 0.21.1 → 0.22.0

package/README.md

@@ -1,49 +1,44 @@
-# ChartPlugin
+# @univerjs-pro/sheets-chart-ui
 
-[![npm version](https://img.shields.io/npm/v/@univerjs-pro/sheets-chart-ui)](https://npmjs.org/packages/@univerjs-pro/sheets-chart-ui)
-[![license](https://img.shields.io/npm/l/@univerjs-pro/sheets-chart-ui)](https://img.shields.io/npm/l/@univerjs-pro/sheets-chart-ui)
-![CSS Included](https://img.shields.io/badge/CSS_Included-blue?logo=CSS3)
-![i18n](https://img.shields.io/badge/zh--CN%20%7C%20en--US-cornflowerblue?label=i18n)
+[![npm version](https://img.shields.io/npm/v/@univerjs-pro/sheets-chart-ui?style=flat-square)](https://npmjs.com/package/@univerjs-pro/sheets-chart-ui)
+[![downloads](https://img.shields.io/npm/dm/@univerjs-pro/sheets-chart-ui?style=flat-square)](https://npmjs.com/package/@univerjs-pro/sheets-chart-ui)
 
+`@univerjs-pro/sheets-chart-ui` provides chart UI integration for Univer Sheets.
 
-### Installation
+## Package Overview
 
-Chart Feature provide the ability to insert floating charts based on range data in spreadsheets.
+| Package | UMD global | CSS | Locales | Facade entry |
+| --- | --- | :---: | :---: | :---: |
+| `@univerjs-pro/sheets-chart-ui` | `UniverProSheetsChartUi` | Yes | Yes | No |
 
-This feature includes the following plugin packages:
+## Installation
 
-- `@univerjs-pro/sheets-chart` - Chart plugin
-- `@univerjs-pro/sheets-chart-ui` - Chart UI plugin
-
-```shell npm2yarn
-npm install @univerjs-pro/sheets-chart @univerjs-pro/sheets-chart-ui
+```sh
+pnpm add @univerjs-pro/sheets-chart-ui
+# or
+npm install @univerjs-pro/sheets-chart-ui
 ```
 
+Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
 
 ## Usage
 
-```typescript
-import { LocaleType, merge, Univer } from '@univerjs/core';
-import { defaultTheme } from "@univerjs/themes";
-import { UniverSheetsChartPlugin } from '@univerjs-pro/sheets-chart';
-import { UniverSheetsChartUIPlugin } from '@univerjs-pro/sheets-chart-ui';
-import SheetsChartZhCN from '@univerjs-pro/sheets-chart/locale/zh-CN';
-import SheetsChartUIZhCN from '@univerjs-pro/sheets-chart-ui/locale/zh-CN';
-
+```ts
 import '@univerjs-pro/sheets-chart-ui/lib/index.css';
+import EnUS from '@univerjs-pro/sheets-chart-ui/locale/en-US';
+import { UniverSheetsChartUIPlugin } from '@univerjs-pro/sheets-chart-ui';
 
-const univer = new Univer({
-  theme: defaultTheme,
-  locale: LocaleType.ZH_CN,
-  locales: {
-    [LocaleType.ZH_CN]: merge(
-      {},
-      SheetsChartZhCN,
-      SheetsChartUIZhCN
-    ),
-  },
-});
-
-univer.registerPlugin(UniverSheetsChartPlugin);
 univer.registerPlugin(UniverSheetsChartUIPlugin);
+
+// Merge EnUS into your Univer locale map when this package contributes UI text.
 ```
+
+## Integration Notes
+
+Use this package with `@univerjs-pro/sheets-chart` when users need chart editing UI.
+
+## Resources
+
+- [Documentation](https://docs.univer.ai/guides/pro)
+- [NPM package](https://npmjs.com/package/@univerjs-pro/sheets-chart-ui)
+