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

315 lines
17 KiB
Markdown
Raw Normal View History

docs: capitalize K in word koa (#1126)
2018-01-31 05:05:00 +00:00
<img src="/docs/logo.png" alt="Koa middleware framework for nodejs"/>
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]
chore: unify badge's style (#914)
2017-02-26 07:57:49 +00:00
[![OpenCollective Backers][backers-image]](#backers)
[![OpenCollective Sponsors][sponsors-image]](#sponsors)
chore: add pr welcoming badge (#1291)
2019-01-14 16:35:24 +00:00
[![PR's Welcome][pr-welcoming-image]][pr-welcoming-url]
travis badge
2013-11-08 09:16:26 +00:00
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
Expressive HTTP middleware framework 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.
Initial commit
2013-08-17 07:15:57 +00:00
ocd
2015-11-05 16:42:14 +00:00
Only methods that are common to nearly all HTTP servers are integrated directly into Koa's small ~570 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
docs++
2017-02-25 06:30:11 +00:00
Koa requires __node v7.6.0__ or higher for ES2015 and async function support.
Initial commit
2013-08-17 07:15:57 +00:00
```
update description and such
2019-10-11 17:34:28 +00:00
$ npm install koa-lite
Initial commit
2013-08-17 07:15:57 +00:00
```
docs: capitalize K in word koa (#1126)
2018-01-31 05:05:00 +00:00
## Hello Koa
Initial commit
2013-08-17 07:15:57 +00:00
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
```js
update description and such
2019-10-11 17:34:28 +00:00
const Koa = require('koa-lite');
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
const app = new Koa();
Initial commit
2013-08-17 07:15:57 +00:00
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
// response
app.use(ctx => {
ctx.body = 'Hello Koa';
});
app.listen(3000);
```
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
docs: capitalize K in word koa (#1126)
2018-01-31 05:05:00 +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.
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
- [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
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
## Middleware
docs: create v2 Migration document (#931) * Give v2 migration documentation its own document. Incorporate docs from #533 * Fix mis-capitalization of Koa * Remove unnecessary Dependency section * Hint at koa-convert enabled compatibility * Add section on constructing with new * Clarify es6 constructors are used * Fix varying capitalization * Restore mistakenly removed Dependency changes section * v1.x should not receive feature updates * Add next() to signature, add missing backticks * docs++
2017-03-08 06:59:42 +00:00
readme: fix typo (#951)
2017-03-27 19:37:42 +00:00
Koa is a middleware framework that can take two different kinds of functions as middleware:
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
* async function
readme: update the order of accepted functions(#958) Update the order of accepted functions so that it matches the following blocks of text.
2017-04-14 17:50:31 +00:00
* common function
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
copy tweaks (#731)
2016-05-13 06:27:18 +00:00
Here is an example of logger middleware with each of the different functions:
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
docs++
2017-02-25 06:30:11 +00:00
### ___async___ functions (node v7.6+)
```js
app.use(async (ctx, next) => {
Update Readme.md (#985) Change ```new Date``` to ```Date.now```
2017-05-17 02:38:00 +00:00
const start = Date.now();
docs++
2017-02-25 06:30:11 +00:00
await next();
Update Readme.md (#985) Change ```new Date``` to ```Date.now```
2017-05-17 02:38:00 +00:00
const ms = Date.now() - start;
docs++
2017-02-25 06:30:11 +00:00
console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
});
```
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
### Common function
Add 2.0.0 Examples
2015-10-23 08:36:13 +00:00
Lint JavaScript in Markdown
2016-03-15 15:35:52 +00:00
```js
copy tweaks (#731)
2016-05-13 06:27:18 +00:00
// Middleware normally takes two parameters (ctx, next), ctx is the context for one request,
// next is a function that is invoked to execute the downstream middleware. It returns a Promise with a then function for running code after completion.
Add 2.0.0 Examples
2015-10-23 08:36:13 +00:00
app.use((ctx, next) => {
docs: apply `Date.now()` to all docs (#988)
2017-05-21 15:33:25 +00:00
const start = Date.now();
Add 2.0.0 Examples
2015-10-23 08:36:13 +00:00
return next().then(() => {
docs: apply `Date.now()` to all docs (#988)
2017-05-21 15:33:25 +00:00
const ms = Date.now() - start;
update readme
2015-11-07 17:09:58 +00:00
console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
Add 2.0.0 Examples
2015-10-23 08:36:13 +00:00
});
});
```
docs: create v2 Migration document (#931) * Give v2 migration documentation its own document. Incorporate docs from #533 * Fix mis-capitalization of Koa * Remove unnecessary Dependency section * Hint at koa-convert enabled compatibility * Add section on constructing with new * Clarify es6 constructors are used * Fix varying capitalization * Restore mistakenly removed Dependency changes section * v1.x should not receive feature updates * Add next() to signature, add missing backticks * docs++
2017-03-08 06:59:42 +00:00
### Koa v1.x Middleware Signature
Convert generator-mw with deprecation warning
2016-03-14 14:51:14 +00:00
docs: create v2 Migration document (#931) * Give v2 migration documentation its own document. Incorporate docs from #533 * Fix mis-capitalization of Koa * Remove unnecessary Dependency section * Hint at koa-convert enabled compatibility * Add section on constructing with new * Clarify es6 constructors are used * Fix varying capitalization * Restore mistakenly removed Dependency changes section * v1.x should not receive feature updates * Add next() to signature, add missing backticks * docs++
2017-03-08 06:59:42 +00:00
The middleware signature changed between v1.x and v2.x. The older signature is deprecated.
Initial commit
2013-08-17 07:15:57 +00:00
docs: create v2 Migration document (#931) * Give v2 migration documentation its own document. Incorporate docs from #533 * Fix mis-capitalization of Koa * Remove unnecessary Dependency section * Hint at koa-convert enabled compatibility * Add section on constructing with new * Clarify es6 constructors are used * Fix varying capitalization * Restore mistakenly removed Dependency changes section * v1.x should not receive feature updates * Add next() to signature, add missing backticks * docs++
2017-03-08 06:59:42 +00:00
**Old signature middleware support will be removed in v3**
Initial commit
2013-08-17 07:15:57 +00:00
docs: create v2 Migration document (#931) * Give v2 migration documentation its own document. Incorporate docs from #533 * Fix mis-capitalization of Koa * Remove unnecessary Dependency section * Hint at koa-convert enabled compatibility * Add section on constructing with new * Clarify es6 constructors are used * Fix varying capitalization * Restore mistakenly removed Dependency changes section * v1.x should not receive feature updates * Add next() to signature, add missing backticks * docs++
2017-03-08 06:59:42 +00:00
Please see the [Migration Guide](docs/migration.md) for more information on upgrading from v1.x and
using v1.x middleware with v2.x.
Initial commit
2013-08-17 07:15:57 +00:00
readme docs++ (#932) * Better expose documentation in overview readme * Add code examples for context, request and response * docs++ * fix indentation
2017-03-08 07:04:43 +00:00
## Context, Request and Response
Each middleware receives a Koa `Context` object that encapsulates an incoming
http message and the corresponding response to that message. `ctx` is often used
as the parameter name for the context object.
```js
app.use(async (ctx, next) => { await next(); });
```
Koa provides a `Request` object as the `request` property of the `Context`.
Koa's `Request` object provides helpful methods for working with
http requests which delegate to an [IncomingMessage](https://nodejs.org/api/http.html#http_class_http_incomingmessage)
from the node `http` module.
Koa provides a `Response` object as the `response` property of the `Context`.
Koa's `Response` object provides helpful methods for working with
http responses which delegate to a [ServerResponse](https://nodejs.org/api/http.html#http_class_http_serverresponse)
.
Koa's pattern of delegating to Node's request and response objects rather than extending them
provides a cleaner interface and reduces conflicts between different middleware and with Node
itself as well as providing better support for stream handling. The `IncomingMessage` can still be
directly accessed as the `req` property on the `Context` and `ServerResponse` can be directly
accessed as the `res` property on the `Context`.
Here is an example using Koa's `Response` object to stream a file as the response body.
```js
app.use(async (ctx, next) => {
await next();
ctx.response.type = 'xml';
ctx.response.body = fs.createReadStream('really_large.xml');
});
```
The `Context` object also provides shortcuts for methods on its `request` and `response`. In the prior
Remove accepts, cache-content-type and content-type. Replace content-disposition with one that doesn’t use safe-buffer
2019-09-29 19:17:14 +00:00
examples, `ctx.type` can be used instead of `ctx.response.type`.
readme docs++ (#932) * Better expose documentation in overview readme * Add code examples for context, request and response * docs++ * fix indentation
2017-03-08 07:04:43 +00:00
For more information on `Request`, `Response` and `Context`, see the [Request API Reference](docs/api/request.md),
[Response API Reference](docs/api/response.md) and [Context API Reference](docs/api/context.md).
## Koa Application
The object created when executing `new Koa()` is known as the Koa application object.
The application object is Koa's interface with node's http server and handles the registration
of middleware, dispatching to the middleware from http, default error handling, as well as
configuration of the context, request and response objects.
Learn more about the application object in the [Application API Reference](docs/api/index.md).
## Documentation
- [Usage Guide](docs/guide.md)
- [Error Handling](docs/error-handling.md)
- [Koa for Express Users](docs/koa-vs-express.md)
- [FAQ](docs/faq.md)
- [API documentation](docs/api/index.md)
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
## Babel setup
docs: update babel setup closes #783
2016-07-23 17:48:20 +00:00
docs: update readme to add babel 7 instructions (#1274)
2018-12-07 07:23:18 +00:00
If you're not using `node v7.6+`, we recommend setting up `babel` with [`@babel/preset-env`](https://babeljs.io/docs/en/next/babel-preset-env):
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
```bash
docs: update readme to add babel 7 instructions (#1274)
2018-12-07 07:23:18 +00:00
$ npm install @babel/register @babel/preset-env @babel/cli --save-dev
Initial commit
2013-08-17 07:15:57 +00:00
```
docs: update readme to add babel 7 instructions (#1274)
2018-12-07 07:23:18 +00:00
In development, you'll want to use [`@babel/register`](https://babeljs.io/docs/en/next/babel-register):
docs: create v2 Migration document (#931) * Give v2 migration documentation its own document. Incorporate docs from #533 * Fix mis-capitalization of Koa * Remove unnecessary Dependency section * Hint at koa-convert enabled compatibility * Add section on constructing with new * Clarify es6 constructors are used * Fix varying capitalization * Restore mistakenly removed Dependency changes section * v1.x should not receive feature updates * Add next() to signature, add missing backticks * docs++
2017-03-08 06:59:42 +00:00
docs: update readme to add babel 7 instructions (#1274)
2018-12-07 07:23:18 +00:00
```bash
node --require @babel/register <your-entry-file>
```
In production, you'll want to build your files with [`@babel/cli`](https://babeljs.io/docs/en/babel-cli). Suppose you are compiling a folder `src` and you wanted the output to go to a new folder `dist` with non-javascript files copied:
```bash
babel src --out-dir dist --copy-files
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
```
docs: create v2 Migration document (#931) * Give v2 migration documentation its own document. Incorporate docs from #533 * Fix mis-capitalization of Koa * Remove unnecessary Dependency section * Hint at koa-convert enabled compatibility * Add section on constructing with new * Clarify es6 constructors are used * Fix varying capitalization * Restore mistakenly removed Dependency changes section * v1.x should not receive feature updates * Add next() to signature, add missing backticks * docs++
2017-03-08 06:59:42 +00:00
And have your `.babelrc` setup:
```json
{
"presets": [
docs: update readme to add babel 7 instructions (#1274)
2018-12-07 07:23:18 +00:00
["@babel/preset-env", {
docs: create v2 Migration document (#931) * Give v2 migration documentation its own document. Incorporate docs from #533 * Fix mis-capitalization of Koa * Remove unnecessary Dependency section * Hint at koa-convert enabled compatibility * Add section on constructing with new * Clarify es6 constructors are used * Fix varying capitalization * Restore mistakenly removed Dependency changes section * v1.x should not receive feature updates * Add next() to signature, add missing backticks * docs++
2017-03-08 06:59:42 +00:00
"targets": {
"node": true
}
}]
]
}
```
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
Add Troubleshooting documentation (#921) * Move Common Problems wiki documentation to troubleshooting.md * Fix header levels and TOC linking * Change header structure, move causes to their own sections * Fix fragment capitalization * Add an example for missing await * Cleanup language due to problem generalization * Add visibility for troubleshooting * Fix fragment typo
2017-03-01 23:50:02 +00:00
## Troubleshooting
docs: create v2 Migration document (#931) * Give v2 migration documentation its own document. Incorporate docs from #533 * Fix mis-capitalization of Koa * Remove unnecessary Dependency section * Hint at koa-convert enabled compatibility * Add section on constructing with new * Clarify es6 constructors are used * Fix varying capitalization * Restore mistakenly removed Dependency changes section * v1.x should not receive feature updates * Add next() to signature, add missing backticks * docs++
2017-03-08 06:59:42 +00:00
Check the [Troubleshooting Guide](docs/troubleshooting.md) or [Debugging Koa](docs/guide.md#debugging-koa) in
Add Troubleshooting documentation (#921) * Move Common Problems wiki documentation to troubleshooting.md * Fix header levels and TOC linking * Change header structure, move causes to their own sections * Fix fragment capitalization * Add an example for missing await * Cleanup language due to problem generalization * Add visibility for troubleshooting * Fix fragment typo
2017-03-01 23:50:02 +00:00
the general Koa guide.
Initial commit
2013-08-17 07:15:57 +00:00
## Running tests
```
docs: command is wrong for running tests (#1065)
2017-09-26 04:08:21 +00:00
$ npm test
Initial commit
2013-08-17 07:15:57 +00:00
```
docs: Add security vulnerability disclosure instructions to the Readme (#1283)
2018-12-12 04:24:18 +00:00
## Reporting vulnerabilities
To report a security vulnerability, please do not open an issue, as this notifies attackers
of the vulnerability. Instead, please email [dead_horse](mailto:heyiyu.deadhorse@gmail.com) and [jonathanong](mailto:me@jongleberry.com) to
disclose.
add authors
2013-08-26 02:16:57 +00:00
## Authors
readme: link to AUTHORS file
2015-10-12 07:04:58 +00:00
See [AUTHORS](AUTHORS).
add authors
2013-08-26 02:16:57 +00:00
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
## Community
- [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)
readme: update URLs based on HTTP redirects see: a25ab12116cf5b0dd608e009a01c700278a9b3e7
2016-03-15 19:38:42 +00:00
- [Reddit Community](https://www.reddit.com/r/koajs)
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
- [Mailing list](https://groups.google.com/forum/#!forum/koajs)
docs: ddd Chinese docs link for v2.x (#1092)
2017-11-03 03:13:19 +00:00
- [中文文档 v1.x](https://github.com/guo-yu/koa-guide)
- [中文文档 v2.x](https://github.com/demopark/koa-docs-Zh-CN)
docs: update docs for koa v2 update readme and request, response toJSON method update readme update readme update readme update readme update readme update readme update docs update doc pretty readme update docs fix then callback
2015-11-25 03:51:14 +00:00
- __[#koajs]__ on freenode
Update Readme.md I'll fill everyone in a bit
2017-04-26 16:46:25 +00:00
## Job Board
Looking for a career upgrade?
<a href="https://astro.netlify.com/automattic"><img src="https://astro.netlify.com/static/automattic.png"></a>
<a href="https://astro.netlify.com/segment"><img src="https://astro.netlify.com/static/segment.png"></a>
<a href="https://astro.netlify.com/auth0"><img src="https://astro.netlify.com/static/auth0.png"/></a>
Added OpenCollective backers and sponsors (#748) * Added OpenCollective backers and sponsors * Removed become a backer/sponsor links
2016-06-14 01:53:25 +00:00
## Backers
chore: unify badge's style (#914)
2017-02-26 07:57:49 +00:00
Support us with a monthly donation and help us continue our activities.
Added OpenCollective backers and sponsors (#748) * Added OpenCollective backers and sponsors * Removed become a backer/sponsor links
2016-06-14 01:53:25 +00:00
<a href="https://opencollective.com/koajs/backer/0/website" target="_blank"><img src="https://opencollective.com/koajs/backer/0/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/1/website" target="_blank"><img src="https://opencollective.com/koajs/backer/1/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/2/website" target="_blank"><img src="https://opencollective.com/koajs/backer/2/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/3/website" target="_blank"><img src="https://opencollective.com/koajs/backer/3/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/4/website" target="_blank"><img src="https://opencollective.com/koajs/backer/4/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/5/website" target="_blank"><img src="https://opencollective.com/koajs/backer/5/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/6/website" target="_blank"><img src="https://opencollective.com/koajs/backer/6/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/7/website" target="_blank"><img src="https://opencollective.com/koajs/backer/7/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/8/website" target="_blank"><img src="https://opencollective.com/koajs/backer/8/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/9/website" target="_blank"><img src="https://opencollective.com/koajs/backer/9/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/10/website" target="_blank"><img src="https://opencollective.com/koajs/backer/10/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/11/website" target="_blank"><img src="https://opencollective.com/koajs/backer/11/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/12/website" target="_blank"><img src="https://opencollective.com/koajs/backer/12/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/13/website" target="_blank"><img src="https://opencollective.com/koajs/backer/13/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/14/website" target="_blank"><img src="https://opencollective.com/koajs/backer/14/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/15/website" target="_blank"><img src="https://opencollective.com/koajs/backer/15/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/16/website" target="_blank"><img src="https://opencollective.com/koajs/backer/16/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/17/website" target="_blank"><img src="https://opencollective.com/koajs/backer/17/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/18/website" target="_blank"><img src="https://opencollective.com/koajs/backer/18/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/19/website" target="_blank"><img src="https://opencollective.com/koajs/backer/19/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/20/website" target="_blank"><img src="https://opencollective.com/koajs/backer/20/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/21/website" target="_blank"><img src="https://opencollective.com/koajs/backer/21/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/22/website" target="_blank"><img src="https://opencollective.com/koajs/backer/22/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/23/website" target="_blank"><img src="https://opencollective.com/koajs/backer/23/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/24/website" target="_blank"><img src="https://opencollective.com/koajs/backer/24/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/25/website" target="_blank"><img src="https://opencollective.com/koajs/backer/25/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/26/website" target="_blank"><img src="https://opencollective.com/koajs/backer/26/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/27/website" target="_blank"><img src="https://opencollective.com/koajs/backer/27/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/28/website" target="_blank"><img src="https://opencollective.com/koajs/backer/28/avatar.svg"></a>
<a href="https://opencollective.com/koajs/backer/29/website" target="_blank"><img src="https://opencollective.com/koajs/backer/29/avatar.svg"></a>
## Sponsors
chore: unify badge's style (#914)
2017-02-26 07:57:49 +00:00
Become a sponsor and get your logo on our README on Github with a link to your site.
Added OpenCollective backers and sponsors (#748) * Added OpenCollective backers and sponsors * Removed become a backer/sponsor links
2016-06-14 01:53:25 +00:00
<a href="https://opencollective.com/koajs/sponsor/0/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/1/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/2/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/3/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/4/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/5/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/6/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/7/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/8/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/9/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/9/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/10/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/10/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/11/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/11/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/12/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/12/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/13/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/13/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/14/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/14/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/15/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/15/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/16/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/16/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/17/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/17/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/18/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/18/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/19/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/19/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/20/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/20/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/21/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/21/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/22/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/22/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/23/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/23/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/24/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/24/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/25/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/25/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/26/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/26/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/27/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/27/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/28/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/28/avatar.svg"></a>
<a href="https://opencollective.com/koajs/sponsor/29/website" target="_blank"><img src="https://opencollective.com/koajs/sponsor/29/avatar.svg"></a>
Initial commit
2013-08-17 07:15:57 +00:00
# License
docs: add link to the license file (#1290)
2018-12-27 08:21:54 +00:00
[MIT](https://github.com/koajs/koa/blob/master/LICENSE)
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: update URLs based on HTTP redirects see: a25ab12116cf5b0dd608e009a01c700278a9b3e7
2016-03-15 19:38:42 +00:00
[npm-url]: https://www.npmjs.com/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
chore: unify badge's style (#914)
2017-02-26 07:57:49 +00:00
[coveralls-image]: https://img.shields.io/codecov/c/github/koajs/koa.svg?style=flat-square
use codecov instead of coveralls
2016-03-03 22:40:43 +00:00
[coveralls-url]: https://codecov.io/github/koajs/koa?branch=master
chore: unify badge's style (#914)
2017-02-26 07:57:49 +00:00
[backers-image]: https://opencollective.com/koajs/backers/badge.svg?style=flat-square
[sponsors-image]: https://opencollective.com/koajs/sponsors/badge.svg?style=flat-square
[gitter-image]: https://img.shields.io/gitter/room/koajs/koa.svg?style=flat-square
added gitter badge
2014-11-04 16:59:11 +00:00
[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
chore: add pr welcoming badge (#1291)
2019-01-14 16:35:24 +00:00
[pr-welcoming-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
chore: Update PR-welcome badge url (#1299)
2019-02-02 01:44:11 +00:00
[pr-welcoming-url]: https://github.com/koajs/koa/pull/new
Reference in a new issue Copy permalink