summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkali kaneko <kali@leap.se>2018-12-11 14:00:53 +0100
committerkali kaneko <kali@leap.se>2018-12-11 14:02:06 +0100
commit5540bc0f605f3d318a0b773861dcf26d21f9ef56 (patch)
treeeec07207f2d378f282df33d9dfa22babbdd6a4a7
parent541f5ea6dda62c4b80200453768422c48ac159d0 (diff)
add description
-rw-r--r--README.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 55c2ae7..5da13a0 100644
--- a/README.rst
+++ b/README.rst
@@ -1,4 +1,11 @@
-Get GeoIP City database
+Geolocation
+=======================
+This is a simple geolocation service.
+
+It provides the remote ip (via X-Forwarded-For header, if present), country code, city, and geographical coordinates.
+Information is provided in plain text format, under ``/``, and in json, under ``/json``.
+
+Prerequisites
-----------------------
You can use ``geoipupdate`` to download MaxMind's City database::