Skip to content

Commit 17069d7

Browse files
committed
docs: 更新 README 以及相关文档
1 parent 91cea0e commit 17069d7

File tree

2 files changed

+30
-5
lines changed

2 files changed

+30
-5
lines changed

README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,38 @@
1-
# json-tree
1+
# json-tree-pro
22

33
JSON tree view for Vue.
44

5+
6+
## Installation & Usage
7+
8+
```bash
9+
npm i json-tree-pro
10+
```
11+
12+
```js
13+
// main.js
14+
import Vue from 'vue'
15+
import JsonTree from 'json-tree-pro'
16+
import 'json-tree-pro/lib/JsonTree.css'
17+
18+
Vue.component('JsonTree', JsonTree)
19+
```
20+
21+
```vue
22+
<JsonTree :json-data="{ name: 'Tom', age: 7 }" />
23+
```
24+
25+
26+
## Demo & Docs
27+
528
| GitHub | Gitee |
629
|-------------------------------------------------------|-----------------------------------------------------|
730
| [Repository](https://github.com/mathink12/json-tree) | [Repository](https://gitee.com/mathink12/json-tree) |
831
| [Demo & Docs](https://mathink12.github.io/json-tree/) | [Demo & Docs](http://mathink12.gitee.io/json-tree/) |
932

1033
![demo](./docs/imgs/json-tree.gif)
1134

35+
1236
## License
1337

1438
[MIT](http://opensource.org/licenses/MIT)

docs/getting-started/README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Getting started
22

33
1. 安装 Install
4-
5-
comming soon...
4+
```bash
5+
npm i json-tree-pro
6+
```
67

78
2. 使用 Usage
89
```js
910
// main.js
1011
import Vue from 'vue'
11-
import JsonTree from 'json-tree'
12-
import 'json-tree/lib/JsonTree.css'
12+
import JsonTree from 'json-tree-pro'
13+
import 'json-tree-pro/lib/JsonTree.css'
1314

1415
Vue.component('JsonTree', JsonTree)
1516
```

0 commit comments

Comments
 (0)