docs: set correct package name in readme

README.md

@@ -3,7 +3,7 @@
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 [![GitHub license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/LabEG/reca/blob/main/LICENSE)
 
-# WebMon - Realtime user WebMonitoring
+# Bretrics - Realtime user Browser Monitoring
 
 Monitor the performance of the user's browser and code for real users. Allows you to collect WebVitals metrics, performance and business metrics through the Prometheuse monitoring system.
 
@@ -36,10 +36,10 @@ yarn add @mts-pjsc/bretrics
 The package has a pre-configured monitoring mode that includes the necessary webvitals metrics.
 
 ``` typescript
-import {webmon} from "@mts-pjsc/bretrics";
+import {bretrics} from "@mts-pjsc/bretrics";
 
-webmon
-    .setup({apiPath: "/webmon"}) // <-- microservice deploy location
+bretrics
+    .setup({apiPath: "/bretrics"}) // <-- microservice deploy location
     .useDefaultMonitoring()
     .sendMetrics({my_metric: 5}); // <-- custom metrics
 ```
@@ -51,10 +51,10 @@ If you need to send custom metric, you must use the `sendMetrics` method.
 Prometheus labels can be set as default for all metrics, or individually for each value.
 
 ``` typescript
-import {webmon} from "@mts-pjsc/bretrics";
+import {bretrics} from "@mts-pjsc/bretrics";
 
-webmon
-    .setup({apiPath: "/webmon"})
+bretrics
+    .setup({apiPath: "/bretrics"})
     .useDefaultMonitoring()
     .setLabels({stage: "beta", path: location.pathname})
     .sendMetrics({
@@ -67,14 +67,14 @@ webmon
 
 The default labels will be added to the metrics if you didn't pass them in the `sendMetrics` method.
 
-### Example WebMonitoring customization
+### Example Bretrics customization
 
 The library exports the web monitoring constructor class, so you can inherit from it and implement logic according to OOP principles.
 
 ``` typescript
-import {WebMonitoring} from "@mts-pjsc/bretrics";
+import {Bretrics} from "@mts-pjsc/bretrics";
 
-export class WebMonitoringService extends WebMonitoring {
+export class BretricsService extends Bretrics {
 
     public override sendMetrics (metric: Record<string, number>): this {
         super.sendMetrics(metric);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mts-pjsc/bretrics",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Web Monitoring",
   "main": "dist/index.js",
   "type": "module",

src/index.ts

@@ -2,9 +2,9 @@ import type {Metric} from "web-vitals";
 import {onLCP, onFID, onCLS, onFCP, onINP, onTTFB} from "web-vitals";
 import type {IMetric} from "./interfaces/IMetric";
 
-export class WebMonitoring {
+export class Bretrics {
 
-    public apiPath: string = "/webmon";
+    public apiPath: string = "/bretrics";
 
     public labels: Record<string, number | string> = {};
 
@@ -120,6 +120,7 @@ export class WebMonitoring {
         return sendMetrics;
     }
 
+    // eslint-disable-next-line @typescript-eslint/class-methods-use-this
     protected getDeviceType (): string {
         const ua = navigator.userAgent;
         if ((/(tablet|ipad|playbook|silk)|(android(?!.*mobi))/iu).test(ua)) {
@@ -135,5 +136,4 @@ export class WebMonitoring {
 
 }
 
-export const webmonitoring = new WebMonitoring();
-export const webmon = webmonitoring;
+export const bretrics = new Bretrics();