From 30a7da6e8358347f2b3f10658736b1eabfeb7fd9 Mon Sep 17 00:00:00 2001 From: Ian Griffiths Date: Fri, 13 Sep 2019 09:07:39 +0100 Subject: [PATCH] Improve descriptions (#3) * Add NuGet shield to README.md #2 * Fix copy/paste error in IMM shield #2 * Update NuGet package description #2 * Add description of supported message types to README.md #2 * Add GIS to NuGet package tag list #2 --- README.md | 20 ++++++++++++++++++-- Solutions/Ais.Net/Ais.Net.csproj | 4 ++-- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ec7d322..d0dc56c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,27 @@ # Ais.Net -[![Build Status](https://dev.azure.com/endjin-labs/Ais.Net/_apis/build/status/ais-dotnet.Ais.Net?branchName=master)](https://dev.azure.com/endjin-labs/Ais.Net/_build/latest?definitionId=2&branchName=master) +[![#](https://img.shields.io/nuget/v/Ais.Net.svg)](https://www.nuget.org/packages/Ais.Net/) [![Build Status](https://dev.azure.com/endjin-labs/Ais.Net/_apis/build/status/ais-dotnet.Ais.Net?branchName=master)](https://dev.azure.com/endjin-labs/Ais.Net/_build/latest?definitionId=2&branchName=master) [![GitHub license](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://raw.githubusercontent.com/ais-dotnet/Ais.Net/master/LICENSE) [![GitHub license](https://img.shields.io/badge/License-NLOD-blue.svg)](https://data.norge.no/nlod/en/2.0) -[![IMM](https://endimmfuncdev.azurewebsites.net/api/imm/github/ais-dotnet/Corvus.Extensions/total?cache=false)](https://endimmfuncdev.azurewebsites.net/api/imm/github/ais-dotnet/Ais.Net/total?cache=false) +[![IMM](https://endimmfuncdev.azurewebsites.net/api/imm/github/ais-dotnet/Ais.Net/total?cache=false)](https://endimmfuncdev.azurewebsites.net/api/imm/github/ais-dotnet/Ais.Net/total?cache=false) .NET Standard, high performance, zero allocation AIS decoder, which can process millions of AIVDM/AIVDO sentences per second on a single core. +## Supported Message Types + +This library has been developed to support specific applications, so it only supports message types that have been needed to date in those applications. The following message types are currently supported. + +| ID(s) | Name | +| --- | --- | +| 1, 2, 3 | Position Report Class A | +| 5 | Static Voyage Related Data | +| 18 | Standard Class B CS Position Report | +| 19 | Extended Class B CS Position Report | +| 24 | Static Data Report | +| 27 | Long Range AIS Broadcast message | + +See https://gpsd.gitlab.io/gpsd/AIVDM.html for a complete list of message types. + + ## Licenses [![GitHub license](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://raw.githubusercontent.com/ais-dotnet/Ais.Net/master/LICENSE) diff --git a/Solutions/Ais.Net/Ais.Net.csproj b/Solutions/Ais.Net/Ais.Net.csproj index f3c4f2d..8a0c5fc 100644 --- a/Solutions/Ais.Net/Ais.Net.csproj +++ b/Solutions/Ais.Net/Ais.Net.csproj @@ -21,8 +21,8 @@ AGPL-3.0-only - AIS message parser - ais + High performance, zero allocation AIS message decoder, which can process millions of AIVDM/AIVDO sentences per second on a single core. Sponsored by endjin. + ais;aisvdm;aivdo;nmea;marine;gis;iot;aiforearth;endjin