various internal documentation updates

Hopefully this gives new hackers a better overview of
how the components relate to each other.

1 files changed, 3 insertions, 0 deletions

diff --git a/public-inbox-learn b/public-inbox-learn
index 3b0dae8e..0c7b4199 100755
--- a/public-inbox-learn
+++ b/public-inbox-learn
@@ -1,6 +1,9 @@
 #!/usr/bin/perl -w
 # Copyright (C) 2014-2015 all contributors <meta@public-inbox.org>
 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
+#
+# Used for training spam (via SpamAssassin) and removing messages from a
+# public-inbox
 my $usage = "$0 (spam|ham) < /path/to/message";
 use strict;
 use warnings;