README: mention API diverge and ABI compatibility.
[portableproplib.git] / README
bloba91c6d92a30d340e9879602f418bfaf23827df96
1 Portable Property container object library
2 ------------------------------------------------------------------------------
4 The proplib library provides an abstract interface for creating and
5 manipulating property lists.  Property lists have object types for
6 boolean values, opaque data, numbers, and strings.  Structure is provided
7 by the array and dictionary collection types.
9 Property lists can be passed across protection boundaries by translating
10 them to an external representation.  This external representation is an
11 XML document whose format is described by the following DTD:
13   http://www.apple.com/DTDs/PropertyList-1.0.dtd
17 This proplib version is the same version than is available on NetBSD, but
18 with the exception that NetBSD specific code has been removed and
19 it has been converted to be built throught the GNU autotools.
21 Since version 0.4, the API has diverged a bit, notably this version supports
22 reading and writting gzipped compressed plist files thanks to zlib
23 (implemented by myself).
25 The ABI remains compatible and therefore applications using proplib for NetBSD
26 can be used without modifications with the portable proplib version.
28 It should be mentioned that NetBSD's proplib code is a free,
29 clean room and from scratch implementation based in the specifications
30 available for Mac OS X, written by Jason R. Thorpe.
32 I'd like to thank you Jason R. Thorpe for such a great library.
34         -- Juan Romero Pardines <xtraeme@gmail.com>