From 5540bc0f605f3d318a0b773861dcf26d21f9ef56 Mon Sep 17 00:00:00 2001
From: kali kaneko <kali@leap.se>
Date: Tue, 11 Dec 2018 14:00:53 +0100
Subject: add description

---
 README.rst | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

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::
-- 
cgit v1.2.3