From a824b32e5d0b6c3055752efe69f0b4ed01c0f694 Mon Sep 17 00:00:00 2001 From: Theo Gravity Date: Mon, 20 May 2024 11:35:41 -0700 Subject: [PATCH] docs: update intro copy for README --- .changeset/six-pillows-share.md | 7 +++++++ README.md | 9 ++++----- package-lock.json | 4 ++-- 3 files changed, 13 insertions(+), 7 deletions(-) create mode 100644 .changeset/six-pillows-share.md diff --git a/.changeset/six-pillows-share.md b/.changeset/six-pillows-share.md new file mode 100644 index 0000000..0935b82 --- /dev/null +++ b/.changeset/six-pillows-share.md @@ -0,0 +1,7 @@ +--- +"loglayer": patch +--- + +Update README copy + +Updates the README intro to sound less... odd. diff --git a/README.md b/README.md index 0b8f9a9..a252838 100755 --- a/README.md +++ b/README.md @@ -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. diff --git a/package-lock.json b/package-lock.json index 7e595b9..e881ab1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "loglayer", - "version": "4.3.1", + "version": "4.3.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "loglayer", - "version": "4.3.1", + "version": "4.3.2", "license": "MIT", "devDependencies": { "@biomejs/biome": "^1.6.4",