Skip to content

Commit

Permalink
Updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
mattjohnsonpint committed Dec 30, 2016
1 parent 69a7c41 commit 1bd8a57
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,40 @@ GeoTimeZone

Provides an IANA time zone identifier from latitude and longitude coordinates.

## Installation

```powershell
PM> Install-Package GeoTimeZone
```

Example:
## Supported Environments

As of version 2.0, The Nuget package targets `netstandard1.0` and `portable40-net40+sl5+win8+wp8`.
This provides support for the most environments, including:
- .NET Core (Windows, Mac, Linux, etc.)
- .NET Framework 4.0+
- Windows 8, 8.1, 10, WinRT, UWP, etc.
- Xamarian for iOS / Android
- Windows Phone 8+
- Silverlight 5

## Example Usage

```csharp
string tz = TimeZoneLookup.GetTimeZone(50.4372, -3.5559).Result; // "Europe/London"
```

## Usage Notes

This library uses the time zone border definitions from the [Timezone Boundary Builder][1] project,
which in-turn derive from [Open Street Map][2]. As some international borders are the subject of dispute,
the results may or may not align with your worldview. Use at your own risk.

## License

This library is provided free of charge, under the terms of the [MIT license][3].


Note: this uses the public domain time zone border map data from http://efele.net/maps/tz/world/ which may or may not align with your worldview. Use at your own risk.
[1]: https://github.com/evansiroky/timezone-boundary-builder
[2]: https://www.openstreetmap.org/
[3]: https://raw.githubusercontent.com/mj1856/GeoTimeZone/master/LICENSE

0 comments on commit 1bd8a57

Please sign in to comment.