Skip to content

Commit

Permalink
chore(logger): Update description to match implementation (#907)
Browse files Browse the repository at this point in the history
I noticed that the description of our logger doesn't match the implementation anymore.
  • Loading branch information
blaine-arcjet authored Jun 10, 2024
1 parent 09391f7 commit 0840358
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ find a specific one through the categories and descriptions below.
- [`arcjet`](./arcjet/README.md): JS SDK core.
- [`@arcjet/protocol`](./protocol/README.md): JS interface
into the Arcjet protocol.
- [`@arcjet/logger`](./logger/README.md): Logging interface which mirrors the
console interface but allows log levels.
- [`@arcjet/logger`](./logger/README.md): Lightweight logger which mirrors the
Pino structured logger interface.
- [`@arcjet/decorate`](./decorate/README.md): Utilities for decorating responses
with information.
- [`@arcjet/duration`](./duration/README.md): Utilities for parsing duration
Expand Down
5 changes: 3 additions & 2 deletions logger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
</a>
</p>

[Arcjet][arcjet] logging interface which mirrors the `console` interface but
allows log levels.
[Arcjet][arcjet] lightweight logger which mirrors the [Pino][pino-api]
structured logger interface.

## Installation

Expand Down Expand Up @@ -47,4 +47,5 @@ to one of: `"DEBUG"`, `"LOG"`, `"WARN"`, or `"ERROR"`.
Licensed under the [Apache License, Version 2.0][apache-license].

[arcjet]: https://arcjet.com
[pino-api]: https://github.com/pinojs/pino/blob/8db130eba0439e61c802448d31eb1998cebfbc98/docs/api.md#logger
[apache-license]: http://www.apache.org/licenses/LICENSE-2.0
2 changes: 1 addition & 1 deletion logger/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@arcjet/logger",
"version": "1.0.0-alpha.13",
"description": "Arcjet logging interface which mirrors the console interface but allows log levels",
"description": "Arcjet lightweight logger which mirrors the Pino structured logger interface",
"license": "Apache-2.0",
"homepage": "https://arcjet.com",
"repository": {
Expand Down

0 comments on commit 0840358

Please sign in to comment.