From 27bb023ae9992ac1c8b3d2595568c7991eab6923 Mon Sep 17 00:00:00 2001 From: Enrico Deleo Date: Fri, 1 Jul 2022 20:22:55 +0200 Subject: [PATCH] docs: update readme --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b49515d..7e67856 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,25 @@ ![NPM](https://img.shields.io/npm/v/pino-airbrake-transport) ![GitHub Workflow Status](https://github.com/enricodeleo/pino-airbrake-transport/actions/workflows/pino-airbrake-transport.yml/badge.svg?branch=main) -This module provides a 'transport' for pino that sends errors to [Airbrake](https://airbrake.io?ref=enricodeleo.com). +This module provides a _transport_ for [Pino](https://getpino.io/?ref=enricodeleo.com) that sends errors to [Airbrake](https://airbrake.io?ref=enricodeleo.com). + +Thanks to this module you can automatically transmit logs, stacktrace and context from pino to Aibrake.io. The best part is that this happens in a worker thread so that the impact of logging is reduced to the minimum. ## Install +### npm + ```shell npm i pino-airbrake-transport ``` -## usage +### yarn + +```shell +yarn add pino-airbrake-transport +``` + +## Usage ```typescript import pino from "pino";