Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Adrián Moreno <adrian@morenomartinez.com>
  • Loading branch information
adrianmo committed May 11, 2020
1 parent 2af0ae3 commit 7c49351
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Expand Up @@ -6,9 +6,9 @@ This is a NMEA library for the Go programming language (Golang).

## Features

- Parse individual NMEA sentences.
- Ability to register custom parser for unsupported sentence types.
- User friendly MIT license
- Parse individual NMEA 0183 sentences
- Register custom parser for unsupported sentence types
- User-friendly MIT license

## Installing

Expand Down Expand Up @@ -50,11 +50,11 @@ At this moment, this library supports the following sentence types:
| [DBS](https://gpsd.gitlab.io/gpsd/NMEA.html#_dbs_depth_below_surface) | Depth Below Surface |
| [DBT](https://gpsd.gitlab.io/gpsd/NMEA.html#_dbt_depth_below_transducer) | Depth below transducer |

If you need to parse a message that contains a unsupported sentence type you can implement and register your own message parser and get yourself unblocked immediately. Check the example below to know how to [implement and register a custom message parser](#custom-message-parsing). However, if you think your custom message parser could be benefitial to other users we encourage you to contribute back to the library by submitting a PR and get it included in the list of supported sentences.
If you need to parse a message that contains an unsupported sentence type you can implement and register your own message parser and get yourself unblocked immediately. Check the example below to know how to [implement and register a custom message parser](#custom-message-parsing). However, if you think your custom message parser could be beneficial to other users we encourage you to contribute back to the library by submitting a PR and get it included in the list of supported sentences.

## Examples

### Supported message parsing
### Built-in message parsing

```go
package main
Expand Down Expand Up @@ -185,4 +185,4 @@ Please feel free to submit issues or fork the repository and send pull requests

## License

Check [LICENSE](LICENSE).
Check [LICENSE](LICENSE).

0 comments on commit 7c49351

Please sign in to comment.