Skip to content

Commit

Permalink
chore: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yyx990803 committed Feb 18, 2020
1 parent c3028ad commit 8f463b3
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
15 changes: 15 additions & 0 deletions packages/server-renderer/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
# @vue/server-renderer

``` js
const { createSSRApp } = require('vue')
const { renderToString } = require('@vue/server-renderer')

const app = createSSRApp({
data: () => ({ msg: 'hello' }),
template: `<div>{{ msg }}</div>`
})

;(async () => {
const html = await renderToString(app)
console.log(html)
})()
```

0 comments on commit 8f463b3

Please sign in to comment.