From 3805c5fbe8ea96da19a495631db2f388ed968193 Mon Sep 17 00:00:00 2001
From: ale <ale@incal.net>
Date: Wed, 30 Oct 2019 11:37:30 +0000
Subject: [PATCH] Slightly more documentation

---
 README.md | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index e548dc8..22aa9d4 100644
--- a/README.md
+++ b/README.md
@@ -26,8 +26,20 @@ supported are *append* and *scan* (and internally a
 *delete-older-than* that periodically wipes entries that are too old
 to be relevant anymore).
 
-Querying reputation for an IP consists in scanning the database for
-a pre-defined window of time in the past, and passing the results
-to a *scoring script* (currently written in an embedded language),
-that applies aggregation and weighting and returns the final score.
+Querying reputation for an IP consists in scanning the database for a
+pre-defined window of time in the past, and passing the results to a
+*scoring script* (currently written in [an embedded
+language](https://github.com/d5/tengo)), that applies aggregation and
+weighting and returns the final score.
 
+## RPC interface
+
+The server provides a simple GRPC interface that is used for event
+submission and querying. The query API is a simple IP lookup,
+returning a score. This conceivably could be turned into a DNS-based
+API as well.
+
+## Third-party sources
+
+It would be nice to allow the scoring script to consult other IP-based
+third-party sources, such as DNSBLs, or GeoIP lookups, etc.
-- 
GitLab