From c81b155a83908b8bec422fd2cc07866ff977106b Mon Sep 17 00:00:00 2001 From: "kali kaneko (leap communications)" Date: Thu, 25 Feb 2021 21:41:50 +0100 Subject: [docs] explain tool name --- README.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index d978019..8e89875 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,17 @@ -Geolocation +Menshen ======================= -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``. +Menshen is a geolocation and gateway status service for LEAP VPN. + +In chinese folk religions, `menshen ` +are guardians of doors and gates. + +The geolocation service 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``. + +Menshen will also soon provide a "gateway health" service to help clients choose the +nearest, less congested gateway. This feature is currently undergoing heavy changes. Prerequisites ----------------------- -- cgit v1.2.3