From 8d8f97a859b3a3e779c0b0673467a9e2c6fa4029 Mon Sep 17 00:00:00 2001 From: Bertold Van den Bergh Date: Tue, 6 Mar 2018 00:30:09 +0100 Subject: [PATCH] Readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..163a07a --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# ZoneDetect + +This is a C library that allows you to find an area a point belongs to using a database file. A typical example would be looking up the country or timezone given a latitude and longitude. + +The API should be self-explanatory from zonedetect.h. A small demo is included (demo.c) + +In the future (after cleanup) I will also commit the program used to convert shapefiles to the binary database files, a merged country+timezone file and an automated testsuite. + +### Online API +You can test the library using an online API: [https://api.bertold.org/geozone](https://api.bertold.org/geozone) +It takes the following GET parameters: + +* lat: Latitude. +* lon: Longitude. +* c: Set to one (c=1) to produce compact JSON. + +For example: [https://api.bertold.org/geozone?lat=51&lon=5](https://api.bertold.org/geozone?lat=51&lon=5) +Please do not use this API in an application that will result in a lot of server load :) + \ No newline at end of file