Skip to content

Commit

Permalink
Improve descriptions (#3)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
idg10 authored and HowardvanRooijen committed Sep 13, 2019
1 parent 69ce094 commit 30a7da6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
4 changes: 2 additions & 2 deletions Solutions/Ais.Net/Ais.Net.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@

<PropertyGroup>
<PackageLicenseExpression>AGPL-3.0-only</PackageLicenseExpression>
<PackageDescription>AIS message parser</PackageDescription>
<PackageTags>ais</PackageTags>
<PackageDescription>High performance, zero allocation AIS message decoder, which can process millions of AIVDM/AIVDO sentences per second on a single core. Sponsored by endjin.</PackageDescription>
<PackageTags>ais;aisvdm;aivdo;nmea;marine;gis;iot;aiforearth;endjin</PackageTags>
<PackageReleaseNotes></PackageReleaseNotes>
</PropertyGroup>

Expand Down

0 comments on commit 30a7da6

Please sign in to comment.