Merge pull request #2 from Ferada/punycode
[puri-unicode.git] / README
1 PURI-UNICODE - Portable URI Library with UTF-8 encoding support
2 ===============================================================
3
4 AUTHORS
5 -------
6 Franz, Inc <http://www.franz.com>
7 Kevin Rosenberg <kevin@rosenberg.net>
8 Andrey Moskvitin <archimag@gmail.com>
9
10
11 DOWNLOAD
12 --------
13 puri-unicode home: http://github.com/archimag/puri-unicode
14 Portable tester home: http://files.b9.com/tester/
15
16
17 SUPPORTED PLATFORMS
18 -------------------
19    AllegroCL, CLISP, CMUCL, Lispworks, SBCL, ClosureCL
20
21
22 OVERVIEW
23 --------
24 This is portable Universal Resource Identifier library for Common Lisp
25 programs. It parses URI according to the RFC 2396 specification. It's
26 is based on Franz, Inc's opensource URI package and has been ported to
27 work other CL implementations. It is licensed under the LLGPL which
28 is included in this distribution.
29
30 A regression suite is included which uses Franz's open-source tester
31 library. I've ported that library for use on other CL
32 implementations. Puri completes 126/126 regression tests successfully.
33
34 Franz's unmodified documentation file is included in the file
35 uri.html. 
36
37 DIFFERENCES BETWEEN PURI-UNICODE and PURI
38 -----------------------------------------
39
40 * puri-unicode uses the babbel for support utf-8 encoding
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.
52