# Report Nest.js API usage metrics to [README.com](https://docs.readme.com/docs/api-metrics-in-readme)

Collect and publish Nest.js API usage metrics to README.io

[![NPM](https://badgen.net/npm/v/readme-metric-reporter-nestjs)](https://www.npmjs.com/readme-metric-reporter-nestjs)
[![Coverage](https://codecov.io/gh/igrek8/readme-metric-reporter-nestjs/branch/main/graph/badge.svg)](https://codecov.io/gh/igrek8/readme-metric-reporter-nestjs)
![Release](https://badgen.net/github/checks/igrek8/readme-metric-reporter-nestjs)
![License](https://badgen.net/github/license/igrek8/readme-metric-reporter-nestjs)

## Installation

```bash
npm install --save readme-metric-reporter-nestjs

yarn add readme-metric-reporter-nestjs
```

## View in the dashboard

<details>
  <summary>Review a request metric</summary>
  <img alt="dashboard" src="./media/readme-view-api-log.png" />
</details>

## Usage

[Example](./src/demo/main.ts)