From 7bbed0bc2836f700c75cae0d4712954dd0de427d Mon Sep 17 00:00:00 2001 From: jan Date: Fri, 1 Apr 2022 17:41:56 -0700 Subject: [PATCH] add caveats to readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 3015e05..8789b33 100644 --- a/README.md +++ b/README.md @@ -106,4 +106,11 @@ Open nets: - Useful classes, namely `NetsInfo` and `NetName`, are in `snarled.tracker`. - `snarled.interfaces` contains helper code for interfacing with other packages. +## Caveats + +This package is slow, dumb, and the code is ugly. There's only a basic test case. + +If you know what you're doing, you could probably do a much better job of it. + +...but you *have* heard of it :)