Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
enricodeleo committed Jul 1, 2022
1 parent e914f5e commit 27bb023
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down

0 comments on commit 27bb023

Please sign in to comment.