From 71ea6455c3efbf65c44130b5deda4e4a2d93aaad Mon Sep 17 00:00:00 2001
From: Yanzhen Yu <yanzhen@smartx.com>
Date: Fri, 28 Dec 2018 11:03:30 +0800
Subject: [PATCH] update docs and add compatibility note

---
 README.md      |  6 ++++--
 guide.md       | 14 +++++++++-----
 guide.zh_CN.md |  4 ++++
 3 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 111c37eadd..8ede55ebda 100644
--- a/README.md
+++ b/README.md
@@ -42,12 +42,14 @@ rrweb is mainly composed of 3 parts:
   - hijack Ajax/fetch API and record request events
   - use TraceKit to log exception events
 
-<!-- ## Internal Design
+## Internal Design
+
+*Since the design docs were originally written in Chinese, we do not have the English version yet, but it would be available as soon as possible.*
 
 - [serialization](./docs/serialization.md)
 - [incremental snapshot](./docs/observer.md)
 - [replay](./docs/replay.md)
-- [sandbox](./docs/sandbox.md) -->
+- [sandbox](./docs/sandbox.md)
 
 ## Contribute Guide
 
diff --git a/guide.md b/guide.md
index 59b58588ac..a07a048b45 100644
--- a/guide.md
+++ b/guide.md
@@ -24,7 +24,7 @@ Also, you can link to a specific version number that you can update manually:
 
 #### Only include the recorder code
 
-rrweb's code includes both the record and the replay parts. Most of the time you only need include the record part into your target web Apps.
+rrweb's code includes both the record and the replay parts. Most of the time you only need to include the record part into your targeted web Apps.
 This also can be done by using the CDN service:
 
 ```html
@@ -39,12 +39,16 @@ npm install --save rrweb
 
 rrweb provides both commonJS and ES modules bundles, which is easy to use with the popular bundlers.
 
+### Compatibility Note
+
+rrweb does **not** support IE11 and below, because it uses the `MutationObserver` API which was supoorted by [these browsers](https://caniuse.com/#feat=mutationobserver).
+
 ## Getting Started
 
 ### Record
 
 If you only include record code with `<script>`, then you can use the global variable `rrwebRecord` which is the same as `rrweb.record`.
-The following sample codes will use `rrweb` variable the default exporter of this library.
+The following sample codes will use the variable `rrweb` which is the default exporter of this library.
 
 ```js
 rrweb.record({
@@ -87,7 +91,7 @@ setInterval(save, 10 * 1000);
 
 #### Privacy
 
-You may found some contents on the webpage were not willing to be recorded, then you can use the following approaches:
+You may find some contents on the webpage which are not willing to be recorded, then you can use the following approaches:
 
 - An element with the class name `.rr-block` will not be recorded. Instead, it will replay as a placeholder with the same dimension.
 - An element with the class name `.rr-ignore` will not record its input events.
@@ -126,7 +130,7 @@ The replayer accepts options as its constructor's second parameter, and it has t
 
 #### Use rrweb-player
 
-Since rrweb's replayer only provides a basic UI, you can choose rrweb-replayer which was based on rrweb's public APIs but has a feature-rich replayer UI.
+Since rrweb's replayer only provides a basic UI, you can choose rrweb-replayer which is based on rrweb's public APIs but has a feature-rich replayer UI.
 
 ##### Installation
 
@@ -211,7 +215,7 @@ Run `npm run repl` to launch a browser and ask for a URL you want to test on the
 Enter the url you want to record, e.g https://react-redux.realworld.io:
 ```
 
-Waiting for the browser to open the specified page and print following messages on the CLI:
+Waiting for the browser to open the specified page and print the following messages on the CLI:
 
 ```
 Enter the url you want to record, e.g https://react-redux.realworld.io: https://github.com
diff --git a/guide.zh_CN.md b/guide.zh_CN.md
index 15dd95bb14..f6e2cf3d6f 100644
--- a/guide.zh_CN.md
+++ b/guide.zh_CN.md
@@ -36,6 +36,10 @@ npm install --save rrweb
 
 rrweb 同时提供 commonJS 和 ES modules 两种格式的打包文件，易于和常见的打包工具配合使用。
 
+### 兼容性
+
+由于使用 `MutationObserver` API，rrweb 不支持 IE11 以下的浏览器。可以从[这里](https://caniuse.com/#feat=mutationobserver)找到兼容的浏览器列表。
+
 ## 快速开始
 
 ### 录制