Skip to content

Commit

Permalink
docs: update intro copy for README
Browse files Browse the repository at this point in the history
  • Loading branch information
theogravity committed May 20, 2024
1 parent 48c90d8 commit a824b32
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
7 changes: 7 additions & 0 deletions .changeset/six-pillows-share.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"loglayer": patch
---

Update README copy

Updates the README intro to sound less... odd.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@
![NPM Downloads](https://img.shields.io/npm/dm/loglayer)
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)

`loglayer` standardizes log entry definitions, context handling, metadata, and error reporting, streamlining your logging process using your logging library of choice like `pino` / `winston` / `bunyan` / etc.
`loglayer` standardizes log entry definitions, contextual data, metadata, and error reporting, streamlining your logging process using your logging library of choice like `pino` / `winston` / `bunyan` / etc.

Enjoy the simplicity of seamlessly switching between different logging libraries without needing to overhaul your entire codebase, and focus on writing effective logs instead of configuring them:

- Easily swap from `console` (or another logging library) to another logging library with minimal effort.
- Zero dependency library.
- Fluent API for creating log entries with Typescript support.
- Not sure what logging package to use? Start with `console` as the underlying logger (or another logging library) and swap later to another logging library without needing to overhaul your entire codebase.
* Supports `bunyan`, `winston`, `pino`, `roarr`, `log4js-node`, `electron-log`, `signale`, `consola`, and more with installation examples for each.
- Offers an intuitive, dependency-free API developed in TypeScript.
- Has ready-to-use mocks for your unit tests.
- Unit tested against multiple logging libraries to ensure compatibility.

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a824b32

Please sign in to comment.