docs: update g6 version and react-node usage (#5260)

antvis · Dec 12, 2023 · 151a576 · 151a576
1 parent 96016b5
commit 151a576
Showing 5 changed files with 18 additions and 13 deletions.
diff --git a/README.en-US.md b/README.en-US.md
@@ -69,7 +69,7 @@ G6 concentrates on the principle of 'good by default'. In addition, the custom m
 ## Installation (5.0 Alpha)
 
 ```bash
-$ npm install @antv/g6@5.0.0-alpha.8
+$ npm install @antv/g6@5.0.0-beta.28
 ```
 
 ## Usage (5.0 Alpha)

diff --git a/README.md b/README.md
@@ -57,7 +57,7 @@ GIF 未完整加载，[点此看原图](https://mdn.alipayobjects.com/huamei_qa8
 ## 安装 (5.0 Alpha)
 
 ```bash
-$ npm install @antv/g6@5.0.0-alpha.8
+$ npm install @antv/g6@5.0.0-beta.28
 ```
 
 ## 使用 (5.0 Alpha)

diff --git a/packages/react-node/README.md b/packages/react-node/README.md
@@ -7,11 +7,22 @@ Using React Component to Define Your G6 Graph Node
 
 ## Usage
 
-TODO
+```bash
+pnpm install @antv/g6-react-node@2.0.0-beta.1
+```
 
-## Options
+```jsx
+import { createReactNode, createReactGNode } from '@antv/g6-react-node';
+
+const ReactNode = createReactNode({
+  // ... React Component
+});
+
+const ReactGNode = createReactGNode({
+  // ... JSX Component
+});
+```
 
-TODO
 
 ## Development
 
@@ -27,12 +38,6 @@ $ pnpm run build
 
 # build library source code in watch mode
 $ pnpm run build:watch
-
-# build docs
-$ pnpm run docs:build
-
-# check your project for potential problems
-$ pnpm run doctor
 ```
 
 ## LICENSE

diff --git a/packages/site/docs/manual/tutorial/quick-start.en.md b/packages/site/docs/manual/tutorial/quick-start.en.md
@@ -81,7 +81,7 @@ Using G6 in vanilla HTML only requires importing the G6 JS file, as shown below:
 
 ```bash
 # Using npm
-npm install --save @antv/g6@5.0.0
+npm install --save @antv/g6@5.0.0-beta.28
 
 # Using yarn
 yarn add @antv/g6@5.0.0

diff --git a/packages/site/docs/manual/tutorial/quick-start.zh.md b/packages/site/docs/manual/tutorial/quick-start.zh.md
@@ -83,7 +83,7 @@ order: 1
 
 ```bash
 # 使用 npm 安装
-npm install --save @antv/g6@5.0.0
+npm install --save @antv/g6@5.0.0-beta.28
 
 # 使用 yarn 安装
 yarn add @antv/g6@5.0.0