Add README
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
2018-03-18 15:24:57 -08:00
parent a2fc7786f7
commit 7a68c28625
3 changed files with 23 additions and 2 deletions

15
README.md Normal file
View File

@@ -0,0 +1,15 @@
# geoipapi
This provides a small daemon intended to run within for example
a kubernetes to provide MaxMind GeoIP data to other services over
HTTP.
The available APIs are `/api/country?ip=192.0.2.1` returning the
country of the IP and `/api/json?ip=192.0.2.1` providing the maxmind
data in JSON format.
OpenTelemetry tracing is supported with the standard Traceparent http
header, and configuration through the standard environment variables.
(Work great with the opentelemetry collector operator).
There's a small Go API client in `client/geoipapi`.