Add support for square brackets around IPv6 addresses to
[puri.git] / README
1 PURI - Portable URI Library
2 ===========================
3
4 AUTHORS
5 -------
6 Franz, Inc <http://www.franz.com>
7 Kevin Rosenberg <kevin@rosenberg.net>
8
9
10 DOWNLOAD
11 --------
12 Puri home: http://files.kpe.io/puri/
13 Portable tester home: http://files.kpe.io/tester/
14
15
16 SUPPORTED PLATFORMS
17 -------------------
18    AllegroCL, CLISP, CMUCL, Lispworks, OpenMCL, SBCL
19
20 DOCUMENTATION
21 ----------
22 Franz, Inc. has online documenation for the URI package upon which
23 PURI is based:
24    http://franz.com/support/documentation/current/doc/uri.htm
25
26 OVERVIEW
27 --------
28 This is portable Universal Resource Identifier library for Common Lisp
29 programs. It parses URI according to the RFC 2396 specification. It's
30 is based on Franz, Inc's opensource URI package and has been ported to
31 work other CL implementations. It is licensed under the LLGPL which
32 is included in this distribution.
33
34 A regression suite is included which uses Franz's open-source tester
35 library. I've ported that library for use on other CL
36 implementations. Puri completes 126/126 regression tests successfully.
37
38 Franz's unmodified documentation file is included in the file
39 uri.html. 
40
41
42 DIFFERENCES BETWEEN PURI and NET.URI
43 ------------------------------------
44
45 * Puri uses the package 'puri while NET.URI uses the package 'net.uri
46
47 * To signal an error parsing a URI, Puri uses the condition
48   :uri-parse-error while NET.URI uses the condition :parse-error. This
49   divergence occurs because Franz's parse-error condition uses
50   :format-control and :format-arguments slots which are not in the ANSI
51   specification for the parse-error condition.