Skip to content

Commit

Permalink
docs: add shield.io badges + install note (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
mhochsto authored Dec 2, 2024
2 parents 4079e52 + 6d1b52f commit de5a507
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# Nest MQTT

[![NPM Version](https://img.shields.io/npm/v/%40evva%2Fnest-mqtt)](https://www.npmjs.com/package/@evva/nest-mqtt)
[![NPM Downloads](https://img.shields.io/npm/dy/%40evva%2Fnest-mqtt)](https://www.npmjs.com/package/@evva/nest-mqtt)
![NPM Unpacked Size (with version)](https://img.shields.io/npm/unpacked-size/%40evva%2Fnest-mqtt/latest)
![GitHub last commit](https://img.shields.io/github/last-commit/evva-sfw/nest-mqtt)
[![GitHub branch check runs](https://img.shields.io/github/check-runs/evva-sfw/nest-mqtt/main)]([URL](https://github.com/evva-sfw/nest-mqtt/actions))
[![EVVA License](https://img.shields.io/badge/license-EVVA_License-yellow.svg?color=fce500&logo=data:image/svg+xml;base64,PCEtLSBHZW5lcmF0ZWQgYnkgSWNvTW9vbi5pbyAtLT4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjY0MCIgaGVpZ2h0PSIxMDI0IiB2aWV3Qm94PSIwIDAgNjQwIDEwMjQiPgo8ZyBpZD0iaWNvbW9vbi1pZ25vcmUiPgo8L2c+CjxwYXRoIGZpbGw9IiNmY2U1MDAiIGQ9Ik02MjIuNDIzIDUxMS40NDhsLTMzMS43NDYtNDY0LjU1MmgtMjg4LjE1N2wzMjkuODI1IDQ2NC41NTItMzI5LjgyNSA0NjYuNjY0aDI3NS42MTJ6Ij48L3BhdGg+Cjwvc3ZnPgo=)](LICENSE)

## Install

`npm i @evva/nest-mqtt`

## Description

Client implementation for an MQTT Broker that also supports shared subscriptions.
Expand All @@ -11,7 +24,7 @@ $ nest build

## Usage

```
```ts
MqttModule.forRootAsync({
imports: [ConfigModule],
inject: [ConfigService],
Expand All @@ -31,7 +44,7 @@ $ nest build

When using the ConfigService, make sure that the variables are loaded before accessing them.
This usually works as follows:
```
```ts
export class MyModule implements OnModuleInit {


Expand Down

0 comments on commit de5a507

Please sign in to comment.