doc/*: tai64nlocal comes from daemontools, not djbdns.

[djbdns-logparse.git] / doc / README

diff --git a/doc/README b/doc/README
index 07e52b3065531876747228e9d50c967a50b0dc8d..5663669b5f0194b13e1b8ac709db0bc1016d4534 100644 (file)
--- a/doc/README
+++ b/doc/README
@@ -1,4 +1,4 @@
-djbdns-logparse: convert tinydns and dnscache logs to human-readable form
+djbdns-logparse: make tinydns and dnscache logs human-readable
 
 == What is it? ==
 
@@ -21,12 +21,23 @@ read. The line above gets turned into,
 and surely you agree that this is preferable.
 
 
+== Usage ==
+
+Either,
+
+  $ djbdns-logparse < logfile
+
+or
+
+  $  djbdns-logparse log1 [log2 [log3 ...]]
+
+
 == Requirements ==
 
 There are only two:
 
   a) python-3.6 or later, for f-strings support
-  b) the tai64nlocal program from djbdns in your PATH
+  b) the tai64nlocal program from DJB's daemontools on your PATH
 
 
 == History ==
@@ -44,3 +55,18 @@ with heavy assistance from Rob Mayoff's documentation:
 
   * https://www.dqd.com/~mayoff/notes/djbdns/tinydns-log.html
   * https://www.dqd.com/~mayoff/notes/djbdns/dnscache-log.html
+
+
+== Tests ==
+
+The (doctest) test suite can be run with either setuptools,
+
+  $ python setup.py test
+
+or using tox,
+
+  $ tox
+
+Or, you can just run them manually:
+
+  $ python -m doctest -v djbdns/*.py