From 53506863543deb0c8459f29ae1edc53bef4b6b06 Mon Sep 17 00:00:00 2001 From: Tony Brobston Date: Fri, 31 Jan 2020 15:35:31 -0600 Subject: [PATCH 1/2] docs: fix project description --- README.md | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1fbd65a..0da46b9 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 @@ -66,7 +66,7 @@ services: ``` ## Documentation -**[start](docs/modules/_index_.md#const-start)**(`options`: [Options](docs/interfaces/_types_options_.options.md)): *Promise‹void›* +**[start](docs/modules/_index_.md#const-start)**(`options`: [Options](docs/interfaces/_types_options_.options.md)): *Promise‹void›* **[stop](docs/modules/_index_.md#const-stop)**(): *Promise‹void›* ## Feedback diff --git a/package.json b/package.json index beaa5f0..67fe78f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "logs-to-mqtt-publisher", "version": "1.0.4", - "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", From 75d49c0f36a691d5a59179fd6604e5278803985c Mon Sep 17 00:00:00 2001 From: Tony Brobston Date: Fri, 31 Jan 2020 15:56:22 -0600 Subject: [PATCH 2/2] docs: add space in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0da46b9..0b4ce04 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ services: ``` ## Documentation -**[start](docs/modules/_index_.md#const-start)**(`options`: [Options](docs/interfaces/_types_options_.options.md)): *Promise‹void›* +**[start](docs/modules/_index_.md#const-start)**(`options`: [Options](docs/interfaces/_types_options_.options.md)): *Promise‹void›* **[stop](docs/modules/_index_.md#const-stop)**(): *Promise‹void›* ## Feedback