add chinese version readme #86

Gavin-Gong · 2018-06-05T07:02:18Z

No description provided.

yyx990803 · 2018-06-05T13:00:24Z

@Jinjiang 有空的话帮忙润色一下吧

Jinjiang · 2018-06-06T07:05:43Z

README-CN.md

+
+[English](README.md) | 简体中文
+
+[RxJS v6](https://github.com/ReactiveX/rxjs) 集成到 Vue.js.


将 RxJS v6 集成到 Vue.js

Jinjiang · 2018-06-06T07:06:30Z

README-CN.md

+
+[RxJS v6](https://github.com/ReactiveX/rxjs) 集成到 Vue.js.
+
+> **相比 5.0 的破坏式更新**


破坏式更新 -> 不兼容变更

Jinjiang · 2018-06-06T07:07:37Z

README-CN.md

+
+#### NPM + ES2015
+
+**`rxjs` 需要作为`peer dependency`引入.**


peer dependency 的反引号不是必要的，且左右两边建议加空格

Jinjiang · 2018-06-06T07:09:55Z

README-CN.md

+Vue.use(VueRx);
+```
+
+使用 webpack 打包, 默认会使用`dist/vue-rx.esm.js`. 这样引入最小数量的 Rx 操作符并且保证了最小的打包体积


使用 webpack 打包, 默认会使用dist/vue-rx.esm.js
⬇️
webpack 打包时会默认使用 dist/vue-rx.esm.js

句尾漏了句号

Jinjiang · 2018-06-06T07:13:51Z

README-CN.md

+
+#### 全局脚本
+
+如果要在浏览器环境使用, 需要引入 UMD 构建版本 `dist/vue-rx.js`. 在浏览器环境中, UMD 版本默认 `window.rxjs` 已经存在, 因此确保在 Vue.js 和 RxJS 之后引入 `vue-rx.js`. 如果`window.Vue`存在的话, `vue-rx`会自动安装,


在浏览器环境中, UMD 版本默认 window.rxjs 已经存在, 因此确保……
⬇️
浏览器中的 UMD 构建版本会假设 window.rxjs 已经存在, 因此你需要确保……

如果window.Vue存在的话, vue-rx会自动安装
⬇️
如果 window.Vue 存在的话, vue-rx 会自动安装

Jinjiang · 2018-06-06T07:35:47Z

README-CN.md

+    a: 1
+  },
+  subscriptions() {
+    // 用 Rx 操作符声明地映射成另一个属性


声明地 -> 声明式地

Jinjiang · 2018-06-06T07:36:16Z

README-CN.md

+
+#### `$eventToObservable(event)`
+
+转化 vue.$on (包括声明周期事件) 到 Observables. 值会以 `{ name, msg }` 的格式触发:


vue.$on -> vue.$on

Jinjiang · 2018-06-06T07:36:56Z

README-CN.md

+  }
+});
+
+// vm.$once vue-rx 版本


vm.$once 的 vue-rx 版本
注释中的代码也建议加反引号
下同

Jinjiang · 2018-06-06T07:42:38Z

README-CN.md

+
+#### `$fromDOMEvent(selector, event)`
+
+这是一个添加到实例的原型方法. 可以用它根据实例内部元素的 DOM 事件创建 observable. 与 `Rx.Observable.fromEvent` 类似. 甚至在 DOM 渲染前, 在 `subscriptions` 函数中使用都是有用的.


与 Rx.Observable.fromEvent 类似. 甚至在 DOM 渲染前, 在 subscriptions 函数中使用都是有用的.
⬇️
与 Rx.Observable.fromEvent 类似, 但是在 subscriptions 函数内部很有用, 包括在 DOM 被真正渲染前.

Jinjiang · 2018-06-06T07:45:20Z

README-CN.md

+
+转化函数调用为输出调用参数的 observable 队列.
+
+这是一个添加到实例的原型方法. 用来根据函数名创建一个共享的, 热的 observable. 这个函数会被赋值到 vm 方法上去.


会被赋值到 vm 方法上去
⬇️
会被赋值为一个 vm 方法

Jinjiang · 2018-06-06T07:51:50Z

给了一些个人建议
另外中文官网有一份现成的翻译约定 https://github.com/vuejs/cn.vuejs.org/wiki
如果觉得有帮助的话可以参考一下，目前一些细节格式上，比如标点符号和空格的用法，不太一致
谢谢🤝

Gavin-Gong · 2018-06-07T13:38:49Z

@Jinjiang 感谢大佬 Review，根据给的建议修改了一下，如果有错误的地方还请指教

Jinjiang · 2018-06-10T10:53:31Z

README-CN.md


 ### 安装

 #### NPM + ES2015

-**`rxjs` 需要作为`peer dependency`引入.**
+**`rxjs` 需要作为　peer dependency　引入。**


这里“作为　peer dependency　引入”用了全角空格吗？用半角就可以了

Jinjiang · 2018-06-10T10:54:00Z

README-CN.md

@@ -25,11 +25,11 @@ import VueRx from 'vue-rx';
 Vue.use(VueRx);
 ```

-使用 webpack 打包, 默认会使用`dist/vue-rx.esm.js`. 这样引入最小数量的 Rx 操作符并且保证了最小的打包体积
+webpack 打包默认会使用`dist/vue-rx.esm.js`。 这样引入最小数量的 Rx 操作符并且保证了最小的打包体积。


标点符号和中文之间不需要空格，下同

Jinjiang · 2018-06-10T10:57:00Z

README-CN.md

@@ -147,18 +147,18 @@ const plusData$ = this.plus$.pipe(pluck('data'));
 }">+</button>
 ```

-查看 [实例](https://github.com/vuejs/vue-rx/blob/master/example/counter.html).
+更具体的用法请查阅 [实例](https://github.com/vuejs/vue-rx/blob/master/example/counter.html)。


两个汉字之间不需要空格，即便右侧是一个链接，下同

Jinjiang · 2018-06-10T10:59:13Z

还有一些格式上的细节建议🤝

Gavin-Gong · 2018-06-11T13:06:38Z

@Jinjiang 根据建议调整了下，翻译真是个细心活😄。还得多多学习。

yyx990803 · 2018-06-11T16:29:59Z

Thanks!

Gavin-Gong added 3 commits June 5, 2018 14:44

docs: add chinese version readme

47c1cd3

docs: adjust readme layout

38d2798

docs: update readme

e9f5a8e

Jinjiang reviewed Jun 6, 2018

View reviewed changes

Gavin-Gong added 3 commits June 7, 2018 21:09

docs: update doc format

344d167

docs: update doc format

98dd894

docs: update doc format

67ac2ff

Jinjiang reviewed Jun 10, 2018

View reviewed changes

docs: update doc format

e659b58

yyx990803 merged commit 81d2dca into vuejs:master Jun 11, 2018


		[English](README.md) \| 简体中文

		[RxJS v6](https://github.com/ReactiveX/rxjs) 集成到 Vue.js.


		[RxJS v6](https://github.com/ReactiveX/rxjs) 集成到 Vue.js.

		> 相比 5.0 的破坏式更新


		#### NPM + ES2015

		`rxjs` 需要作为`peer dependency`引入.


		#### 全局脚本

		如果要在浏览器环境使用, 需要引入 UMD 构建版本 `dist/vue-rx.js`. 在浏览器环境中, UMD 版本默认 `window.rxjs` 已经存在, 因此确保在 Vue.js 和 RxJS 之后引入 `vue-rx.js`. 如果`window.Vue`存在的话, `vue-rx`会自动安装,


		#### `$eventToObservable(event)`

		转化 vue.$on (包括声明周期事件) 到 Observables. 值会以 `{ name, msg }` 的格式触发:


		#### `$fromDOMEvent(selector, event)`

		这是一个添加到实例的原型方法. 可以用它根据实例内部元素的 DOM 事件创建 observable. 与 `Rx.Observable.fromEvent` 类似. 甚至在 DOM 渲染前, 在 `subscriptions` 函数中使用都是有用的.


		转化函数调用为输出调用参数的 observable 队列.

		这是一个添加到实例的原型方法. 用来根据函数名创建一个共享的, 热的 observable. 这个函数会被赋值到 vm 方法上去.

add chinese version readme #86

add chinese version readme #86

Uh oh!

Conversation

Gavin-Gong commented Jun 5, 2018

Uh oh!

yyx990803 commented Jun 5, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jinjiang commented Jun 6, 2018

Uh oh!

Gavin-Gong commented Jun 7, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jinjiang commented Jun 10, 2018

Uh oh!

Gavin-Gong commented Jun 11, 2018

Uh oh!

yyx990803 commented Jun 11, 2018

Uh oh!

Uh oh!