Skip to content

Commit bfbb7cb

Browse files
committed
feat: rename package to nestjs-metrics-reporter
1 parent 9107b2c commit bfbb7cb

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to nestjs-metrics-client
1+
# Contributing to nestjs-metrics-reporter
22

3-
🎉 Thank you for considering contributing to nestjs-metrics-client! This document outlines the basics you need to know.
3+
🎉 Thank you for considering contributing to nestjs-metrics-reporter! This document outlines the basics you need to know.
44

55
## Ways to Contribute
66

@@ -13,7 +13,7 @@
1313

1414
1. Fork and clone the repository
1515
```bash
16-
git clone https://github.com/your-username/nestjs-metrics-client.git
16+
git clone https://github.com/your-username/nestjs-metrics-reporter.git
1717
```
1818

1919
2. Create a feature branch

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
<div align="center">
55
<h1 style="font-size: 2em;">NestJS Metrics Reporter</h1>
66

7-
[![npm version](https://badge.fury.io/js/nestjs-metrics-client.svg)](https://badge.fury.io/js/nestjs-metrics-client)
8-
<a href="https://www.npmjs.com/package/nestjs-metrics-client" target="_blank"><img src="https://img.shields.io/npm/dm/nestjs-metrics-client" alt="NPM Downloads" /></a>
7+
[![npm version](https://badge.fury.io/js/nestjs-metrics-reporter.svg)](https://badge.fury.io/js/nestjs-metrics-reporter)
8+
<a href="https://www.npmjs.com/package/nestjs-metrics-reporter" target="_blank"><img src="https://img.shields.io/npm/dm/nestjs-metrics-reporter" alt="NPM Downloads" /></a>
99
<a href="https://medium.com/elementor-engineers/avoid-prometheus-mess-in-nestjs-1ea368e3e21e" target="_blank"><img src="https://img.shields.io/badge/Medium-Read%20Article-black?logo=medium" alt="Medium Article" /></a>
1010
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
1111

@@ -23,20 +23,20 @@ Effortlessly report metrics from anywhere in your codebase without complex setup
2323
## Installation
2424

2525
```bash
26-
npm install nestjs-metrics-client
26+
npm install nestjs-metrics-reporter
2727
```
2828

2929
---
3030

3131
## Overview
3232

33-
`nestjs-metrics-client` is a lightweight, **zero-setup** alternative
33+
`nestjs-metrics-reporter` is a lightweight, **zero-setup** alternative
3434
to [@willsoto/nestjs-prometheus](https://github.com/willsoto/nestjs-prometheus), eliminating the need for dependency
3535
injection or extensive configuration.
3636
Instantly report metrics from anywhere in your application using a global static reporter.
3737

3838
```typescript
39-
import { ReporterService } from 'nestjs-metrics-client';
39+
import { ReporterService } from 'nestjs-metrics-reporter';
4040

4141
ReporterService.counter( 'api_requests_total', { endpoint: '/users' } );
4242
```
@@ -59,10 +59,10 @@ graph TD
5959
```
6060
---
6161

62-
## Why Choose `nestjs-metrics-client`?
62+
## Why Choose `nestjs-metrics-reporter`?
6363

6464
🚀 **No Dependency Injection**
65-
Unlike [@willsoto/nestjs-prometheus](https://github.com/willsoto/nestjs-prometheus), `nestjs-metrics-client` removes the
65+
Unlike [@willsoto/nestjs-prometheus](https://github.com/willsoto/nestjs-prometheus), `nestjs-metrics-reporter` removes the
6666
need for cumbersome dependency injection, making your code cleaner and more portable.
6767

6868
🌟 **Effortless Integration**
@@ -82,7 +82,7 @@ Minimal setup required! Just import the `ReporterModule` in your `AppModule`.
8282

8383
```typescript
8484
import { Module } from "@nestjs/common";
85-
import { ReporterModule } from 'nestjs-metrics-client';
85+
import { ReporterModule } from 'nestjs-metrics-reporter';
8686

8787
@Module( {
8888
imports: [
@@ -122,7 +122,7 @@ Once initialized, you can start reporting metrics instantly from anywhere in you
122122

123123
```typescript
124124
import { Injectable } from '@nestjs/common';
125-
import { ReporterService } from 'nestjs-metrics-client';
125+
import { ReporterService } from 'nestjs-metrics-reporter';
126126

127127
@Injectable()
128128
export class UserService {

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "nestjs-metrics-client",
2+
"name": "nestjs-metrics-reporter",
33
"version": "1.0.0",
44
"description": "A global static Prometheus metrics reporter for NestJS applications",
55
"main": "dist/index.js",
@@ -40,12 +40,12 @@
4040
"license": "Apache-2.0",
4141
"repository": {
4242
"type": "git",
43-
"url": "git+https://github.com/netanelavr/nestjs-metrics-client.git"
43+
"url": "git+https://github.com/netanelavr/nestjs-metrics-reporter.git"
4444
},
4545
"bugs": {
46-
"url": "https://github.com/netanelavr/nestjs-metrics-client/issues"
46+
"url": "https://github.com/netanelavr/nestjs-metrics-reporter/issues"
4747
},
48-
"homepage": "https://github.com/netanelavr/nestjs-metrics-client#readme",
48+
"homepage": "https://github.com/netanelavr/nestjs-metrics-reporter#readme",
4949
"dependencies": {
5050
"prom-client": "^14.0.0"
5151
},

0 commit comments

Comments
 (0)