Skip to content

Commit 9378083

Browse files
authored
chore: update README.md file (#131)
## Checklist - [x] I have ensured my pull request is not behind the main or master branch of the original repository. - [x] I have rebased all commits where necessary so that reviewing this pull request can be done without having to merge it first. - [x] I have written a commit message that passes commitlint linting. - [x] I have ensured that my code changes pass linting tests. - [x] I have ensured that my code changes pass unit tests. - [x] I have described my pull request and the reasons for code changes along with context if necessary.
1 parent 2f540b9 commit 9378083

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
# koa-etag
1+
# @koa/etag
22

33
[![NPM version][npm-image]][npm-url]
4-
[![Build status][travis-image]][travis-url]
54
[![Test coverage][coveralls-image]][coveralls-url]
65
[![Dependency Status][david-image]][david-url]
76
[![License][license-image]][license-url]
@@ -13,18 +12,20 @@ Etag support for Koa responses using [etag](https://github.com/jshttp/etag).
1312

1413
```bash
1514
# npm
16-
$ npm install koa-etag
15+
$ npm install @koa/etag
1716
# yarn
18-
$ yarn add koa-etag
17+
$ yarn add @koa/etag
1918
```
2019

2120
## Example
2221

2322
```js
23+
24+
const Koa = require('koa');
25+
const etag = require('@koa/etag');
2426
const conditional = require('koa-conditional-get');
2527
const compress = require('koa-compress');
26-
const etag = require('koa-etag');
27-
const Koa = require('koa');
28+
2829
const app = new Koa();
2930

3031
// must be used before `conditional` and `etag`
@@ -48,11 +49,9 @@ console.log('listening on port 3000');
4849
[MIT](LICENSE)
4950

5051
[npm-image]: https://img.shields.io/npm/v/koa-etag.svg?style=flat-square
51-
[npm-url]: https://npmjs.org/package/koa-etag
52+
[npm-url]: https://npmjs.org/package/@koa/etag
5253
[github-tag]: http://img.shields.io/github/tag/koajs/etag.svg?style=flat-square
5354
[github-url]: https://github.com/koajs/etag/tags
54-
[travis-image]: https://img.shields.io/travis/koajs/etag.svg?style=flat-square
55-
[travis-url]: https://travis-ci.org/koajs/etag
5655
[coveralls-image]: https://img.shields.io/coveralls/koajs/etag.svg?style=flat-square
5756
[coveralls-url]: https://coveralls.io/r/koajs/etag?branch=master
5857
[david-image]: http://img.shields.io/david/koajs/etag.svg?style=flat-square

0 commit comments

Comments
 (0)