diff --git a/README.md b/README.md index 1fbd65a..0b4ce04 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # logs-to-mqtt-publisher -A server-side JavaScript tool that converts log statements to topics and publishes them to an mqtt broker. +A server-side JavaScript tool that converts log statements to topics/messages and publishes them to an mqtt broker. [![npm version](https://badge.fury.io/js/logs-to-mqtt-publisher.svg)](https://badge.fury.io/js/logs-to-mqtt-publisher) [![Build Status](https://travis-ci.com/TonyBrobston/logs-to-mqtt-publisher.svg?branch=master)](https://travis-ci.com/TonyBrobston/logs-to-mqtt-publisher) @@ -10,7 +10,7 @@ A server-side JavaScript tool that converts log statements to topics and publish [![Known Vulnerabilities](https://snyk.io/test/github/TonyBrobston/logs-to-mqtt-publisher/badge.svg?targetFile=package.json)](https://snyk.io/test/github/TonyBrobston/logs-to-mqtt-publisher?targetFile=package.json) [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg)](#contributors) -## Example +## Example ##### [Options](docs/interfaces/_types_options_.options.md) ``` { @@ -46,7 +46,7 @@ A server-side JavaScript tool that converts log statements to topics and publish ##### docker-compose.yml ``` version: '3' - + services: home-assistant: image: homeassistant/home-assistant diff --git a/package.json b/package.json index 80c72fe..9612870 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "logs-to-mqtt-publisher", "version": "1.0.5", - "description": "A server-side JavaScript tool that converts log statements to topics and publishes them to a mqtt broker.", + "description": "A server-side JavaScript tool that converts log statements to topics/messages and publishes them to a mqtt broker.", "main": "./lib/index.js", "repository": { "type": "git",