From 3cfdf0cbb244694604eb1ceaa3147c072ac89121 Mon Sep 17 00:00:00 2001
From: sky <hubcarl@126.com>
Date: Thu, 10 Jan 2019 10:53:11 +0800
Subject: [PATCH] doc: add renderToHtml use description

---
 README.md | 29 +++++++++++++++++++++++------
 1 file changed, 23 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 6aeb095..06230e5 100644
--- a/README.md
+++ b/README.md
@@ -20,11 +20,14 @@
 [download-image]: https://img.shields.io/npm/dm/egg-view-vue-ssr.svg?style=flat-square
 [download-url]: https://npmjs.org/package/egg-view-vue-ssr
 
-vue server side render solution for egg.
+Vue Server Side Render Plugin for Egg.
 
-- support vue server side render and static resource inject html
-- support vue server side render error, auto try client render
-- support asset render layout by nunjucks or ejs enigne 
+## Feature
+
+- Support Vue [Server Side Render Mode](https://www.yuque.com/easy-team/egg-vue/node) And [Vue Client Render Mode](https://www.yuque.com/easy-team/egg-vue/web)
+- Support [Asset Render](https://www.yuque.com/easy-team/egg-vue/asset) Layout by Nunjucks Or ejs Enigne 
+- Support Vue Server Side Render Error, Auto Try Client Render
+- Support Static Resouce Auto Inject to Html
 
 ## Install
 
@@ -55,9 +58,8 @@ exports.vuessr = {
  // manifest: path.join(app.baseDir, 'config/manifest.json'),
  // injectCss: true,
  // injectJs: true,
- // injectRes: []
  // fallbackToClient: true, // fallback to client rendering after server rendering failed
- // afterRender: (html, context) => {
+ // afterRender: (html, ctx) => {
  //   return html;
  // },
 };
@@ -113,6 +115,21 @@ exports.index = function* (ctx) {
 };
 ```
 
+### Server Render, Call `renderToHtml`
+
+> when server render bundle error, will try client render**
+
+> https://www.yuque.com/easy-team/egg-vue/node
+
+```js
+// controller/home.js
+exports.index = function* (ctx) {
+  const html = yield ctx.renderToHtml('index/index.js', { message: 'egg vue server side render'});
+  // you can process html
+  ctx.body = html;
+};
+```
+
 ### Client Render, Call `renderClient`, Use Vue render layout
 
 > https://www.yuque.com/easy-team/egg-vue/web