koa-lite/Readme.md

<img src="https://dl.dropboxusercontent.com/u/6396913/koa/logo.png" alt="koa middleware framework for nodejs" width="255px" />

  [![gitter][gitter-image]][gitter-url]
  [![NPM version][npm-image]][npm-url]
  [![build status][travis-image]][travis-url]
  [![Test coverage][coveralls-image]][coveralls-url]

  Expressive HTTP middleware for node.js to make web applications and APIs more enjoyable to write. Koa's middleware stack flows in a stack-like manner, allowing you to perform actions downstream then filter and manipulate the response upstream. Koa's use of generators also greatly increases the readability and robustness of your application.

  Only methods that are common to nearly all HTTP servers are integrated directly into Koa's small ~550 SLOC codebase. This
  includes things like content negotiation, normalization of node inconsistencies, redirection, and a few others.

  Koa is not bundled with any middleware.

## Installation

```
$ npm install koa
```

  Koa requires __node v4.0.0__ or higher for (partial) ES2015 support.

## Community

 - [API](docs/api/index.md) documentation
 - [Badgeboard](https://koajs.github.io/badgeboard) and list of official modules
 - [Examples](https://github.com/koajs/examples)
 - [Middleware](https://github.com/koajs/koa/wiki) list
 - [Wiki](https://github.com/koajs/koa/wiki)
 - [G+ Community](https://plus.google.com/communities/101845768320796750641)
 - [Reddit Community](http://reddit.com/r/koajs)
 - [Mailing list](https://groups.google.com/forum/#!forum/koajs)
 - [Guide](docs/guide.md)
 - [FAQ](docs/faq.md)
 - [中文文档](https://github.com/turingou/koa-guide)
 - __[#koajs]__ on freenode

## Getting started

 - [Kick-Off-Koa](https://github.com/koajs/kick-off-koa) - An intro to koa via a set of self-guided workshops.
 - [Workshop](https://github.com/koajs/workshop) - A workshop to learn the basics of koa, Express' spiritual successor.
 - [Introduction Screencast](http://knowthen.com/episode-3-koajs-quickstart-guide/) - An introduction to installing and getting started with Koa

## Example

```js
const koa = require('koa');
const app = koa();

// logger

app.use(function *(next){
  const start = new Date;
  yield next;
  const ms = new Date - start;
  console.log(`${this.method} ${this.url} - ${ms}`);
});

// response

app.use(function *(){
  this.body = 'Hello World';
});

app.listen(3000);
```

## Running tests

```
$ make test
```

## Authors

  - [TJ Holowaychuk](https://github.com/tj)
  - [Jonathan Ong](https://github.com/jonathanong)
  - [Julian Gruber](https://github.com/juliangruber)
  - [Yiyu He](https://github.com/dead-horse)

# License

  MIT

[npm-image]: https://img.shields.io/npm/v/koa.svg?style=flat-square
[npm-url]: https://npmjs.org/package/koa
[travis-image]: https://img.shields.io/travis/koajs/koa/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/koajs/koa
[coveralls-image]: https://img.shields.io/coveralls/koajs/koa/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/koajs/koa?branch=master
[gitter-image]: https://badges.gitter.im/Join%20Chat.svg
[gitter-url]: https://gitter.im/koajs/koa?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[#koajs]: https://webchat.freenode.net/?channels=#koajs
Updates logo in README for hi-dpi screens 2013-12-22 06:41:06 +00:00			`<img src="https://dl.dropboxusercontent.com/u/6396913/koa/logo.png" alt="koa middleware framework for nodejs" width="255px" />`
add screencast link we probably should not get too crazy with links here, and maintain them in the Wiki, but this one is really well done! 2014-12-04 09:03:46 +00:00
move gitter badge 2014-11-30 08:03:09 +00:00			`[![gitter][gitter-image]][gitter-url]`
add getting start resource 2014-07-26 06:43:41 +00:00			`[![NPM version][npm-image]][npm-url]`
			`[![build status][travis-image]][travis-url]`
readme: add flat badges and url variables 2014-07-06 01:32:25 +00:00			`[![Test coverage][coveralls-image]][coveralls-url]`
travis badge 2013-11-08 09:16:26 +00:00
improve verbage based on comments 2015-08-31 05:07:54 +00:00			`Expressive HTTP middleware for node.js to make web applications and APIs more enjoyable to write. Koa's middleware stack flows in a stack-like manner, allowing you to perform actions downstream then filter and manipulate the response upstream. Koa's use of generators also greatly increases the readability and robustness of your application.`
Initial commit 2013-08-17 07:15:57 +00:00
update SLOC count sloc lib/ ---------- result ------------ physical lines : 1456 lines of source code : 542 total comment : 700 singleline : 35 multiline : 665 empty : 214 number of files read : 4 ------------------------------ 2014-03-13 01:40:21 +00:00			`Only methods that are common to nearly all HTTP servers are integrated directly into Koa's small ~550 SLOC codebase. This`
Update Readme.md 2015-08-23 15:18:54 +00:00			`includes things like content negotiation, normalization of node inconsistencies, redirection, and a few others.`
Initial commit 2013-08-17 07:15:57 +00:00
improve verbage based on comments 2015-08-31 05:07:54 +00:00			`Koa is not bundled with any middleware.`
Initial commit 2013-08-17 07:15:57 +00:00
			`## Installation`

			```
			`$ npm install koa`
			```

update minimum node version in README 2015-10-11 22:39:48 +00:00			`Koa requires __node v4.0.0__ or higher for (partial) ES2015 support.`
Initial commit 2013-08-17 07:15:57 +00:00
			`## Community`

add koa Request / Response objects and delegation. Closes #52 2013-11-13 17:01:15 +00:00			`- [API](docs/api/index.md) documentation`
Update Readme.md 2014-09-08 00:42:30 +00:00			`- [Badgeboard](https://koajs.github.io/badgeboard) and list of official modules`
readme: add link to examples 2013-12-07 23:09:09 +00:00			`- [Examples](https://github.com/koajs/examples)`
correct the link 2013-11-12 09:43:27 +00:00			`- [Middleware](https://github.com/koajs/koa/wiki) list`
fix wiki link 2013-09-17 13:48:36 +00:00			`- [Wiki](https://github.com/koajs/koa/wiki)`
Initial commit 2013-08-17 07:15:57 +00:00			`- [G+ Community](https://plus.google.com/communities/101845768320796750641)`
Fix broken reddit community link Add required protocol to link 2014-03-09 19:23:40 +00:00			`- [Reddit Community](http://reddit.com/r/koajs)`
Initial commit 2013-08-17 07:15:57 +00:00			`- [Mailing list](https://groups.google.com/forum/#!forum/koajs)`
add guide 2013-09-03 01:25:17 +00:00			`- [Guide](docs/guide.md)`
add FAQ. Closes #12 2013-08-21 05:07:00 +00:00			`- [FAQ](docs/faq.md)`
fix Chinese doc link 2015-04-05 12:24:06 +00:00			`- [中文文档](https://github.com/turingou/koa-guide)`
add a webchat freenode link to irc channel 2015-10-05 23:22:56 +00:00			`- __[#koajs]__ on freenode`
Initial commit 2013-08-17 07:15:57 +00:00
Changed language on readme "Getting start" sounded off so I updated it to "getting started" 2014-08-04 15:34:07 +00:00			`## Getting started`
add getting start resource 2014-07-26 06:43:41 +00:00
add screencast link we probably should not get too crazy with links here, and maintain them in the Wiki, but this one is really well done! 2014-12-04 09:03:46 +00:00			`- [Kick-Off-Koa](https://github.com/koajs/kick-off-koa) - An intro to koa via a set of self-guided workshops.`
			`- [Workshop](https://github.com/koajs/workshop) - A workshop to learn the basics of koa, Express' spiritual successor.`
			`- [Introduction Screencast](http://knowthen.com/episode-3-koajs-quickstart-guide/) - An introduction to installing and getting started with Koa`
add getting start resource 2014-07-26 06:43:41 +00:00
Initial commit 2013-08-17 07:15:57 +00:00			`## Example`

			```js
refactor to use ES6 const change var to const for static require()'d modules make constant var references in app use const keyword refactor context to use es6 constants refactor request to use es6 constants, let block-scope coming next use const in response object for static refs make context tests use es6 constants experimental unit tests -> const use const for static references in unit test over req use const for static refs in res tests update app tests to use const for static refs make the context test use es6 constants for static refs use constants in the README es6 constants seem to work in --harmony on 0.12 too use const's for immutable refs in benchmarks ensure all JS files have blank newline at top add newline to bottom of file where missing add a webchat freenode link to irc channel no need to assign error in catch{}-able test app.silent option to turn off err logging keep test env logging for backwards-compat 2015-10-05 18:23:47 +00:00			`const koa = require('koa');`
			`const app = koa();`
Initial commit 2013-08-17 07:15:57 +00:00
			`// logger`

update readme middleware style 2013-11-08 00:31:16 +00:00			`app.use(function *(next){`
refactor to use ES6 const change var to const for static require()'d modules make constant var references in app use const keyword refactor context to use es6 constants refactor request to use es6 constants, let block-scope coming next use const in response object for static refs make context tests use es6 constants experimental unit tests -> const use const for static references in unit test over req use const for static refs in res tests update app tests to use const for static refs make the context test use es6 constants for static refs use constants in the README es6 constants seem to work in --harmony on 0.12 too use const's for immutable refs in benchmarks ensure all JS files have blank newline at top add newline to bottom of file where missing add a webchat freenode link to irc channel no need to assign error in catch{}-able test app.silent option to turn off err logging keep test env logging for backwards-compat 2015-10-05 18:23:47 +00:00			`const start = new Date;`
update readme middleware style 2013-11-08 00:31:16 +00:00			`yield next;`
refactor to use ES6 const change var to const for static require()'d modules make constant var references in app use const keyword refactor context to use es6 constants refactor request to use es6 constants, let block-scope coming next use const in response object for static refs make context tests use es6 constants experimental unit tests -> const use const for static references in unit test over req use const for static refs in res tests update app tests to use const for static refs make the context test use es6 constants for static refs use constants in the README es6 constants seem to work in --harmony on 0.12 too use const's for immutable refs in benchmarks ensure all JS files have blank newline at top add newline to bottom of file where missing add a webchat freenode link to irc channel no need to assign error in catch{}-able test app.silent option to turn off err logging keep test env logging for backwards-compat 2015-10-05 18:23:47 +00:00			`const ms = new Date - start;`
use template strings in readme es6 2015-10-11 22:43:45 +00:00			console.log(`${this.method} ${this.url} - ${ms}`);
Initial commit 2013-08-17 07:15:57 +00:00			`});`

			`// response`

update readme middleware style 2013-11-08 00:31:16 +00:00			`app.use(function *(){`
			`this.body = 'Hello World';`
Initial commit 2013-08-17 07:15:57 +00:00			`});`

			`app.listen(3000);`
			```

			`## Running tests`

			```
			`$ make test`
			```

add authors 2013-08-26 02:16:57 +00:00			`## Authors`

fix tj's link 2014-11-07 08:12:10 +00:00			`- [TJ Holowaychuk](https://github.com/tj)`
add authors 2013-08-26 02:16:57 +00:00			`- [Jonathan Ong](https://github.com/jonathanong)`
update readme middleware style 2013-11-08 00:31:16 +00:00			`- [Julian Gruber](https://github.com/juliangruber)`
add dead-horse to authors list, close #355 2014-10-09 16:40:59 +00:00			`- [Yiyu He](https://github.com/dead-horse)`
add authors 2013-08-26 02:16:57 +00:00
Initial commit 2013-08-17 07:15:57 +00:00			`# License`

			`MIT`
readme: add flat badges and url variables 2014-07-06 01:32:25 +00:00
readme: update badges 2014-10-09 17:59:57 +00:00			`[npm-image]: https://img.shields.io/npm/v/koa.svg?style=flat-square`
readme: add flat badges and url variables 2014-07-06 01:32:25 +00:00			`[npm-url]: https://npmjs.org/package/koa`
pin badge images to master branch 2014-10-27 16:42:01 +00:00			`[travis-image]: https://img.shields.io/travis/koajs/koa/master.svg?style=flat-square`
readme: add flat badges and url variables 2014-07-06 01:32:25 +00:00			`[travis-url]: https://travis-ci.org/koajs/koa`
pin badge images to master branch 2014-10-27 16:42:01 +00:00			`[coveralls-image]: https://img.shields.io/coveralls/koajs/koa/master.svg?style=flat-square`
readme: add flat badges and url variables 2014-07-06 01:32:25 +00:00			`[coveralls-url]: https://coveralls.io/r/koajs/koa?branch=master`
added gitter badge 2014-11-04 16:59:11 +00:00			`[gitter-image]: https://badges.gitter.im/Join%20Chat.svg`
			`[gitter-url]: https://gitter.im/koajs/koa?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge`
add a webchat freenode link to irc channel 2015-10-05 23:22:56 +00:00			`[#koajs]: https://webchat.freenode.net/?channels=#koajs`