TheThing/koa-lite
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

readme: update docs on released v2

Browse source
This commit is contained in:
jongleberry 2016-03-22 10:50:59 -07:00
parent e4bcdecef2
commit 6ba43810a2
1 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
Readme.md
View file

@ -20,9 +20,16 @@ $ npm install koa
Koa is supported in node v4+ and node v0.12 with the `--harmony-generators` or `--harmony` flag. Koa is supported in node v4+ and node v0.12 with the `--harmony-generators` or `--harmony` flag.
## v2 Alpha ## Koa v2
Koa v2 is currently in alpha. In this new version, the middleware function signature completely changes in favor of ES2015-2016 syntax: Koa v2 is currently released with the `next` tag (meaning it will not be marked as latest).
You can install it with semver:
```bash
npm install koa@2
```
In this new version, the middleware function signature completely changes in favor of ES2015-2016 syntax:
```js ```js
// Koa application is now a class and requires the new operator. // Koa application is now a class and requires the new operator.
@ -43,8 +50,10 @@ app.use(async ctx => {
ctx.body = user; // ctx instead of this ctx.body = user; // ctx instead of this
}); });
``` ```
To learn more about Koa v2, follow [this issue](https://github.com/koajs/koa/issues/533).
To try Koa v2, `npm install koa@next`. Although deprecated, the older, generator-based middleware signature will still work in v2 via [koa-convert](https://github.com/koajs/convert) and will be removed in v3.
To learn more about Koa v2, follow [this issue](https://github.com/koajs/koa/issues/533) or read the docs here: https://github.com/koajs/koa/tree/v2.x/docs.
## Community ## Community