From 2deb763c1c53b8bfb227a2ac8477a7aaae567c2d Mon Sep 17 00:00:00 2001 From: Vincent Batts Date: Thu, 8 Nov 2012 10:23:06 -0500 Subject: [PATCH] adding a README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1407e95 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +Overview +======== + +This is a simple utility, with the intention of reading from a packed +payload, into a searchable tree. + +The tree is comprised of url path bases. + +Also, to be able to take a list of these path bases, and render a packed payload. + + +Algorithm +========= + +For more information on the algorith used to pack the payload, see +https://github.com/jbowes/content-set-packer + + +Compiling +========= + +You can use either ant, or maven. I included the only two jar deps, for local +tools and ant builds. +But the unit tests are currently run with maven. +