Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Adnan Rahic committed Oct 21, 2020
1 parent 4393434 commit 101d4db
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,20 @@ This is a fork of [dainis/node-gcstats](https://github.com/dainis/node-gcstats).
- https://github.com/sematext/spm-agent-nodejs
- https://github.com/sematext/spm-agent

# GCStats
[![Build Status](https://travis-ci.org/adnanrahic/node-gcstats.svg?branch=master)](https://travis-ci.org/dainis/node-gcstats)
To install this package run:
```bash
npm install @sematext/gc-stats
```

# GCStats
[![Build Status](https://travis-ci.com/adnanrahic/node-gcstats.svg?branch=master)](https://travis-ci.com/adnanrahic/node-gcstats)
Exposes stats about V8 GC after it has been executed.

# Usage

Create a new instance of the module and subscribe to `stats`-events from that:

var gc = (require('gc-stats'))();
var gc = (require('@sematext/gc-stats'))();

gc.on('stats', function (stats) {
console.log('GC happened', stats);
Expand Down

0 comments on commit 101d4db

Please sign in to comment.