完善文档

SilentTiger · Feb 20, 2017 · 1afaac1 · 1afaac1
1 parent 03aa326
commit 1afaac1
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -10,12 +10,44 @@ a wrapper of UEditor for vue 2.x
 
 （推荐你用 [cnpm](https://npm.taobao.org)，这会让你的 npm 包安装速度大幅提升）
 
-## Code
-```
-import vue-ueditor from 'vue-ueditor'
+## Setup
 
-<vue-ueditor></vue-ueditor>
-```
+首先，在需要使用 UEditor 的页面引入 UEditor, 并将其添加到 template
+
+![](docs/code01.png) 
+
+然后，你需要下载一份完整的 UEditor 代码包放到项目中的某个目录
+
+![](docs/code02.png)
+
+比如这里我们把 UEditor 代码包放到了 static 目录，如果你是用 vue-cli 初始化项目结构的，那么我推荐你也和我一样把 UEditor 放在 static 目录。如果你想放在别的目录，也可以，但是，一定要记得给 vue-ueditor 设置正确的路径。
+
+![](docs/code04.png)
+
+最后，修改 UEditor 代码中的配置文件，设置 UEditor 的根路径
+
+![](docs/code03.png)
+
+同样，这里的 URL 也最好是绝对路径。如果这里填写的是相对路径，当你在项目的不同目录下的不同页面中使用 UEditor 的时候则很可能会出错。
+
+值得注意的是，上面设置的那些路径，都必需是在服务器上可以访问到的路径，vue-editor 并不会使 webpack 打包项目时把 UEditor 代码包中的代码也包括进来，所以如果你像上面所说的那要把 UEditor 放到了 static 目录，那么站点必需保证 http://domain.com/static/ueditor1_4_3_3/ 这个路径是可访问的状态。
+
+## Usage
+为了开发和使用方便，vue-ueditor 并没有修改或包装 UEditor 的任何功能和接口，而是在编辑器初始化成功的时候，将 UEditor 实例作为 ready 事件的参数传递给使用方，这样你就可以通过这个实例调用 UEditor 的各种功能了。
+
+![](docs/code05.png)
+
+![](docs/code06.png)
+
+如果你需要使用 UEditor 的图片上传功能，记得查看 UEditor 的帮助文档，修改相关配置。
+
+有时候，同一个项目中，不同功能对 UEditor 的配置要求是不一样的，这个时候你需要使用 vue-editor 的 ueditorConfig 属性来为某个 vue-editor 实例执行特殊的配置。
+
+![](docs/code07.png)
+
+这样，第一个 UEditor 编辑器将使用 ueditor.config.js 中的配置，而第二个编辑器将用 editorConfig 中的配置像，覆盖 ueditor.config.js 中的指定配置项目。
+
+最后，提醒一点，如果你在同一个页面中使用了多个编辑器，那么你可能会发现有时候其中的一些编辑器无法正确的被初始化。这时你可以考虑是不是因为你没有正确的使用 key 属性。相关知识请参考 vue 的 API 文档。
 
 ## Lisence
 MIT
diff --git a/docs/code.png b/docs/code.png
diff --git a/docs/code01.png b/docs/code01.png
diff --git a/docs/code02.png b/docs/code02.png
diff --git a/docs/code03.png b/docs/code03.png
diff --git a/docs/code04.png b/docs/code04.png
diff --git a/docs/code05.png b/docs/code05.png
diff --git a/docs/code06.png b/docs/code06.png
diff --git a/docs/code07.png b/docs/code07.png
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "vue-ueditor",
- "version": "0.1.2",
+ "version": "0.1.3",
  "description": "a wrapper of UEditor for vue 2.x",
  "author": "津玮<[email protected]>",
  "repository": {