Add support for square brackets around IPv6 addresses to

[puri.git] / README

diff --git a/README b/README
index f81655c8ab70c6f8ed145bb7e18ec70a78983281..fa5a7a140ac26651fc2c71104c1153ba9074c19d 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,30 @@
 PURI - Portable URI Library
+===========================
 
+AUTHORS
+-------
 Franz, Inc <http://www.franz.com>
 Kevin Rosenberg <kevin@rosenberg.net>
 
+
+DOWNLOAD
+--------
+Puri home: http://files.kpe.io/puri/
+Portable tester home: http://files.kpe.io/tester/
+
+
+SUPPORTED PLATFORMS
+-------------------
+   AllegroCL, CLISP, CMUCL, Lispworks, OpenMCL, SBCL
+
+DOCUMENTATION
+----------
+Franz, Inc. has online documenation for the URI package upon which
+PURI is based:
+   http://franz.com/support/documentation/current/doc/uri.htm
+
+OVERVIEW
+--------
 This is portable Universal Resource Identifier library for Common Lisp
 programs. It parses URI according to the RFC 2396 specification. It's
 is based on Franz, Inc's opensource URI package and has been ported to
@@ -14,11 +36,16 @@ library. I've ported that library for use on other CL
 implementations. Puri completes 126/126 regression tests successfully.
 
 Franz's unmodified documentation file is included in the file
-uri.html. The only divergence in usage between Puri and Franz's
-package is that Puri's symbols are located in the package PURI while
-Franz's original uses the package NET.URI.
+uri.html. 
+
 
-Puri home: http://files.b9.com/puri/
-Portable tester home: http://files.b9.com/tester/
+DIFFERENCES BETWEEN PURI and NET.URI
+------------------------------------
 
+* Puri uses the package 'puri while NET.URI uses the package 'net.uri
 
+* To signal an error parsing a URI, Puri uses the condition
+  :uri-parse-error while NET.URI uses the condition :parse-error. This
+  divergence occurs because Franz's parse-error condition uses
+  :format-control and :format-arguments slots which are not in the ANSI
+  specification for the parse-error condition.