From c38ec13311761a97b9eb18cec1687cf61a954d42 Mon Sep 17 00:00:00 2001 From: mpvader Date: Sun, 19 Mar 2023 08:27:28 +0100 Subject: [PATCH 1/2] README improvements --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4171230..3e8721c 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,20 @@ n2k-signalk [![Build Status](https://travis-ci.org/SignalK/n2k-signalk.svg?branch=master)](https://travis-ci.org/SignalK/n2k-signalk) -NMEA 2000 to Signal K (signalk.github.io) converter. Converts [Canboat analyzer](https://github.com/canboat/canboat/wiki/analyzer) JSON output to [SignalK](http://signalk.github.io/) JSON. +NMEA 2000 to Signal K converter. Converts [Canboat analyzer](https://github.com/canboat/canboat/wiki/analyzer) JSON output to the [Signal K](http://signalk.github.io/) data format (also JSON). -For mapping NMEA 0183 data to SignalK see [nmea0183-signalk](https://github.com/SignalK/nmea0183-signalk). +This package is part of [signalk-server](https://github.com/SignalK/signalk-server). Not a plugin. It can alao be used outside of signalk-server. See Usage section below. + +For mapping NMEA 0183 data to the Signal K data format, see [nmea0183-signalk](https://github.com/SignalK/nmea0183-signalk). USAGE ------------- +**Usage in signalk-server** + +All data connections in signalk-server that are configured as type NMEA 2000 use this code. + **Usage from command line** From 58c6bd22590fa5166e4ccf3badb80002acd3bd99 Mon Sep 17 00:00:00 2001 From: mpvader Date: Sun, 19 Mar 2023 08:32:49 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3e8721c..f2c86d1 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ n2k-signalk NMEA 2000 to Signal K converter. Converts [Canboat analyzer](https://github.com/canboat/canboat/wiki/analyzer) JSON output to the [Signal K](http://signalk.github.io/) data format (also JSON). -This package is part of [signalk-server](https://github.com/SignalK/signalk-server). Not a plugin. It can alao be used outside of signalk-server. See Usage section below. +This package is part of [signalk-server](https://github.com/SignalK/signalk-server). Not a plugin. It can also be used outside of signalk-server. See Usage section below. For mapping NMEA 0183 data to the Signal K data format, see [nmea0183-signalk](https://github.com/SignalK/nmea0183-signalk).