From: Matt Corallo <git@bluematt.me>
Date: Wed, 7 Apr 2021 19:27:25 +0000 (-0400)
Subject: Update README to note lack of sorting.
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=3e6fa8a135ffc2892b0a880b0961b663c3cd812b;p=flowspec-xdp

Update README to note lack of sorting.
---

diff --git a/README.md b/README.md
index b788661..adcc99a 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,11 @@ FlowSpec -> XDP Conversion Utility
 This utility allows you to convert flowspec rules (extracted from a local BIRD instance with birdc)
 to an XDP program. It currently supports the entire flowspec match grammar, rate limits, traffic
 action packet match counting (sample bit) and terminal bit, and traffic marking. The redirect
-community is not supported
+community is not supported.
+
+Note that correctly sorting rules is *not* implemented as it requires implementing the flowspec
+wire serialization format and it may better be done inside bird/birdc. Thus, be vary careful using
+the terminal bit in the traffict action community.
 
 `install.sh` provides a simple example script which will compile and install a generated XDP program
 from the rules in bird's `flowspec4` and `flowspec6` routing tables. It will drop any packets which