Skip to content

Commit

Permalink
update README.md 📋 ..
Browse files Browse the repository at this point in the history
  • Loading branch information
3imed-jaberi committed Sep 9, 2020
1 parent e1e1515 commit ff796cc
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions README.md
@@ -0,0 +1,53 @@

# koa-conditional-get

[![Build Status](https://travis-ci.org/koajs/conditional-get.png)](https://travis-ci.org/koajs/conditional-get)

Conditional GET support for koa.


## Installation

```bash
# npm
$ npm install koa-conditional-get
# yarn
$ yarn add koa-conditional-get
```


## Example

```js
const conditional = require('koa-conditional-get');
const etag = require('koa-etag');
const Koa = require('koa');
const app = new Koa();

// use it upstream from etag so
// that they are present
app.use(conditional());

// add etags
app.use(etag());

// respond
app.use(async function(ctx, next){
await next();

ctx.body = {
name: 'tobi',
species: 'ferret',
age: 2
};
})

app.listen(
3000,
console.log('listening on port 3000')
)
```

## License

[MIT](LICENSE)

0 comments on commit ff796cc

Please sign in to comment.