Skip to content

Commit

Permalink
v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
3imed-jaberi committed Oct 12, 2024
1 parent ed0ec43 commit 662c43a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Output [Common Log Format](http://en.wikipedia.org/wiki/Common_Log_Format) access logs to any stream. Defaults to `process.stdout`.

> Notice: We recommend using `@koa/access-log` for installation, as both `koa-accesslog` and `@koa/access-log` refer to the same module. However, in our next major version bump (v2), we will deprecate `koa-accesslog` and only maintain `@koa/access-log`.
## Install

```bash
Expand All @@ -11,11 +13,22 @@ npm i koa-accesslog
yarn add koa-accesslog
```

or

```bash
# npm ..
npm i @koa/access-log
# yarn ..
yarn add @koa/access-log
```

## Usage

```js
const Koa = require('koa');
const accesslog = require('koa-accesslog');
// or
// const accesslog = require('@koa/access-log');
const app = new Koa();

app.use(accesslog());
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "koa-accesslog",
"version": "0.0.2",
"version": "1.0.0",
"description": "Middleware for common log format access logs",
"main": "index.js",
"files": [
Expand Down

0 comments on commit 662c43a

Please sign in to comment.