From 8f463b385902e7cf4ba62ca1b2b23a3e0b06e77a Mon Sep 17 00:00:00 2001 From: Evan You Date: Tue, 18 Feb 2020 14:56:18 -0500 Subject: [PATCH] chore: readme --- README.md | 10 ++++++++-- packages/server-renderer/README.md | 15 +++++++++++++++ 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5662be8659c..e69835be8df 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,16 @@ The current codebase has basic feature parity with v2.x, together with the changes proposed in [merged RFCs](https://github.com/vuejs/rfcs/pulls?q=is%3Apr+is%3Amerged+label%3A3.x). There is a simple webpack-based setup with Single-File Component support available [here](https://github.com/vuejs/vue-next-webpack-preview). -At this stage, the only major work left is server-side rendering, which we are actively working on. In the meanwhile, we would like our users to start building small experimental apps using the alpha releases to help us identify bugs and stabilize the implementation. - Please note that there could still be undocumented behavior inconsistencies with 2.x. When you run into such a case, please make sure to first check if the behavior difference has already been proposed in an existing RFC. If the inconsistency is not part of an RFC, then it's likely unintended, and an issue should be opened (please make sure to use the [issue helper](https://new-issue.vuejs.org/?repo=vuejs/vue-next) when opening new issues). +## TODOs as of 3.0.0-alpha.5 + +- Suspense support in SSR +- SSR Hydration mismatch handling +- SSR vnode directive support +- SSR integration tests +- 2.x compatible async component support + ## Known Issues - There is currently no way to attach custom instance properties via `Vue.prototype`. diff --git a/packages/server-renderer/README.md b/packages/server-renderer/README.md index 4ce66fb5861..23831e51d3b 100644 --- a/packages/server-renderer/README.md +++ b/packages/server-renderer/README.md @@ -1 +1,16 @@ # @vue/server-renderer + +``` js +const { createSSRApp } = require('vue') +const { renderToString } = require('@vue/server-renderer') + +const app = createSSRApp({ + data: () => ({ msg: 'hello' }), + template: `
{{ msg }}
` +}) + +;(async () => { + const html = await renderToString(app) + console.log(html) +})() +```