Skip to content
This repository was archived by the owner on Jun 23, 2023. It is now read-only.

Commit e2e39ff

Browse files
committed
chore: update README
1 parent 4524371 commit e2e39ff

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

README.en.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,10 @@
1010
<br>
1111
<br>
1212

13-
English | [简体中文](https://github.com/analyticsjs/vue-cnzz-analytics/blob/master/README.zh-CN.md)
13+
[简体中文](https://github.com/analyticsjs/vue-cnzz-analytics/blob/master/README.md) | English
1414

1515
Only 3 kB, this plugin base on the CNZZ analytics, it can help you quickly to collect the page views on your website, including single page web application.
1616

17-
Projects using this plugin need to be import [Vue Router](https://router.vuejs.org/) .
18-
1917
>Since the version v2.0.0, it supports the Vue 3.0, and is compatible with the Vue 2.0, you can see the live demo to learn more.<br>If you haven’t started using Vue 3.0, welcome to read the tutorial [learning Vue3](https://vue3.chengpeiquan.com/) .
2018
2119
## Features
@@ -24,7 +22,7 @@ Projects using this plugin need to be import [Vue Router](https://router.vuejs.o
2422

2523
* Support the deployment of multiple site IDs and corresponding data reporting.
2624

27-
* Supports automatic reporting of PV data generated by route switching (supports hash mode and history mode).
25+
* Supports automatic reporting of PV data generated by route switching (This feature need [Vue Router](https://router.vuejs.org/), It can support hash mode and history mode).
2826

2927
* Support manual submission of page views reports.
3028

@@ -60,7 +58,7 @@ Vue 3.0 :[vue-cnzz-analytics demo for Vue 3.x](https://analyticsjs.github.io/v
6058

6159
Option|Required|Type|Description
6260
:-:|:-:|:-:|-
63-
router|true|object|Vue Router, this plugin is based on Vue Router.
61+
router|false|object|Vue Router(It is optional since v2.2.0.)
6462
siteIdList|true|number[]|The site ids for CNZZ analytics, if only one site needs to be reported, just keep one item in the array.
6563
isDebug|false|boolean|if `true`, it will open the debug mode,you can see the log in the console.
6664

@@ -310,6 +308,10 @@ this.$pushCNZZ.event(
310308
);
311309
```
312310

311+
## CHANGELOG
312+
313+
See:[releases](https://github.com/analyticsjs/vue-cnzz-analytics/releases)
314+
313315
## License
314316

315317
[MIT License](https://github.com/analyticsjs/vue-cnzz-analytics/blob/master/LICENSE) © 2019 [chengpeiquan](https://github.com/chengpeiquan)

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
<br>
1111
<br>
1212

13-
[English](https://github.com/analyticsjs/vue-cnzz-analytics/blob/master/README.md) | 简体中文
13+
简体中文 | [English](https://github.com/analyticsjs/vue-cnzz-analytics/blob/master/README.en.md)
1414

15-
一个只有 3 kB 大小的插件,可以帮你轻松解决 SPA 单页面项目浏览数据不准确的问题,基于 Vue 路由访问轨迹自动向友盟统计平台上报 PV / 事件数据,使用本插件的项目需要引入 [Vue Router](https://router.vuejs.org/)
15+
一个只有 3 kB 大小的插件,可以帮你轻松解决 SPA 单页面项目浏览数据不准确的问题,基于 Vue 路由访问轨迹自动向友盟统计平台上报 PV / 事件数据。
1616

1717
>本插件自 v2.0.0 开始,最新版插件支持在 Vue 3.0 项目下使用,同时兼容 Vue 2.0 项目的使用,具体使用方法请看下方说明以及在线 demo 。<br>对 Vue 3.0 感兴趣,但还在观望的同学,欢迎阅读我踩坑总结的:[Vue3.0学习教程与实战案例](https://vue3.chengpeiquan.com/) (持续更新ing)
1818
@@ -22,7 +22,7 @@
2222

2323
* 支持部署多个站点 ID ,并对应进行数据上报(跨部门合作项目,双方均要收集数据时非常有用)
2424

25-
* 支持自动上报路由切换产生的 PV 数据(支持 hash 模式和 history 模式的地址)
25+
* 支持自动上报路由切换产生的 PV 数据(需引入 [Vue Router](https://router.vuejs.org/)支持 hash 模式和 history 模式的地址)
2626

2727
* 支持手动提交 PV 上报
2828

@@ -34,7 +34,7 @@
3434

3535
## 项目
3636

37-
理论上只要引入了 Vue 和 Vue Router 的项目均可以正常使用,包括但不限于以下类型:
37+
理论上只要引入了 Vue (必须) 和 Vue Router (自 v2.2.0 起是可选) 的项目均可以正常使用,包括但不限于以下类型:
3838

3939
* Vue-CLI 脚手架项目
4040

@@ -58,7 +58,7 @@ Vue 3.0 版本:[vue-cnzz-analytics demo for Vue 3.x](https://analyticsjs.githu
5858

5959
选项|是否必填|选项类型|选项说明
6060
:-:|:-:|:-:|-
61-
router||object|Vue Router,本插件基于路由使用
61+
router||object|Vue Router(自 v2.2.0 版本开始为可选,无路由的单页则不必传该选项)
6262
siteIdList|是|number[]|友盟统计的站点 id 列表,只有一个站点需要上报就保留一个 id 即可
6363
isDebug|否|boolean|是否开启 debug 模式,默认 `false`,开启后会在 F12 控制台打印上报信息
6464

@@ -326,6 +326,10 @@ this.$pushCNZZ.event(
326326
);
327327
```
328328

329+
## 更新记录
330+
331+
点击查看:[releases](https://github.com/analyticsjs/vue-cnzz-analytics/releases)
332+
329333
## License
330334

331335
[MIT License](https://github.com/analyticsjs/vue-cnzz-analytics/blob/master/LICENSE) © 2020 [chengpeiquan](https://github.com/chengpeiquan)

0 commit comments

Comments
 (0)