Skip to content

Commit 7278df3

Browse files
committed
updated readme
1 parent aa1e889 commit 7278df3

1 file changed

Lines changed: 16 additions & 8 deletions

File tree

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,29 @@
1-
# Polyline Algorithm for .NET (.NET Standard 2.1)
1+
# PolylineAlgorithm.Abstraction
22

3-
Lightweight .NET Standard 2.1 library implementing Google Encoded Polyline Algorithm.
4-
It provides types and methods for encoding and decoding polylines.
3+
[![NuGet](https://img.shields.io/nuget/v/PolylineAlgorithm.svg)](https://www.nuget.org/packages/PolylineAlgorithm/)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
[![Build](https://github.com/sramekpete/polyline-algorithm-csharp/actions/workflows/build.yml/badge.svg)](https://github.com/sramekpete/polyline-algorithm-csharp/actions/workflows/build.yml)
56

7+
Lightweight .NET Standard 2.1 library implementing Google Encoded Polyline Algorithm.
8+
Package should be primarily used as baseline for libraries that implement polyline encoding/decoding functionality.
69

710
More info about the algorithm can be found at [Google Developers](https://developers.google.com/maps/documentation/utilities/polylinealgorithm).
811

912
## Prerequisites
1013

11-
.NET Polyline Algorithm is avalable as a NuGet package targeting .NET Standard 2.1.
14+
PolylineAlgorithm.Abstraction is available as a NuGet package targeting .NET Standard 2.1.
15+
16+
.NET CLI: `dotnet add package PolylineAlgorithm.Abstraction`
17+
18+
Package Manager Console: `Install-Package PolylineAlgorithm.Abstraction`
1219

13-
.NET CLI: `dotnet add package PolylineAlgorithm`
20+
## How to use it
1421

15-
Package Manager Console: `Install-Package PolylineAlgorithm`
22+
In the majority of cases you would like to inherit `AbstractPolylineDecoder<TPolyline, TCoordinate>` and `AbstractPolylineEncoder<TCoordinate, TPolyline>` classes and implement abstract methods that are mainly responsible for extracting data from your coordinate and polyline types and creating new instances of them.
1623

17-
## Hot to use it
24+
In some cases you may want to implement your own decoder and encoder from scratch.
25+
In that case you can use `PolylineEncoding` static class that offers static methods for encoding and decoding polylines segments.
1826

19-
### Documentation
27+
## Documentation
2028

2129
Documentation is can be found at [https://sramekpete.github.io/polyline-algorithm-csharp/](https://sramekpete.github.io/polyline-algorithm-csharp/).

0 commit comments

Comments
 (0)