From: Michael Orlitzky <michael@orlitzky.com>
Date: Sat, 17 Sep 2022 11:19:01 +0000 (-0400)
Subject: doc/README: mention usage and tests.
X-Git-Tag: 0.0.1~23
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=4b1a04ef1f9632e4cf898cc6b7d0766f9ee3f7e7;p=djbdns-logparse.git

doc/README: mention usage and tests.
---

diff --git a/doc/README b/doc/README
index 07e52b3..c9a7f4a 100644
--- a/doc/README
+++ b/doc/README
@@ -21,6 +21,17 @@ 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:
@@ -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