Update readme

This commit is contained in:
Bertold Van den Bergh 2019-11-10 21:28:07 +01:00
parent a34073a09c
commit a1d9ccb707

View file

@ -7,16 +7,17 @@ The API should be self-explanatory from zonedetect.h. A small demo is included (
The databases are obtained from [here](https://github.com/evansiroky/timezone-boundary-builder) and converted to the format used by this library.
### Online API
You can test the library using an online API: [https://api.bertold.org/geozone](https://api.bertold.org/geozone)
You can test the library using an online API: [https://timezone.bertold.org/timezone](https://timezone.bertold.org/timezone)
It takes the following GET parameters:
* lat: Latitude.
* lon: Longitude.
* c: Set to one (c=1) to produce compact JSON.
* s: Set to one (s=1) to get only the timezone.
For example: [https://api.bertold.org/geozone?lat=51&lon=5](https://api.bertold.org/geozone?lat=51&lon=5)
For example: [https://timezone.bertold.org/timezone?lat=51&lon=5](https://timezone.bertold.org/timezone?lat=51&lon=5)
You are free to use this API for any application, but I am not responsible for the quality of service. Please contact me if your application requires reliability.
### Demo
An online demo is available here: [https://api-public.bertold.org/demo/geozone.html](https://api-public.bertold.org/demo/geozone.html). Simple click anywhere on the map and see the result of the query.
An online demo is available here: [https://cdn.bertold.org/demo/timezone.html](https://timezone.bertold.org/demo/timezone.html). Simple click anywhere on the map and see the result of the query.