--- CBOR-XS/XS.pm 2013/10/27 22:48:12 1.8 +++ CBOR-XS/XS.pm 2013/10/29 00:20:26 1.11 @@ -28,9 +28,14 @@ =head1 DESCRIPTION -WARNING! THIS IS A PRE-ALPHA RELEASE! IT WILL CRASH, CORRUPT YOUR DATA -AND EAT YOUR CHILDREN! (Actually, apart from being untested and a bit -feature-limited, it might already be useful). +WARNING! This module is very new, and not very well tested (that's up to +you to do). Furthermore, details of the implementation might change freely +before version 1.0. And lastly, the object serialisation protocol depends +on a pending IANA assignment, and until that assignment is official, this +implementation is not interoperable with other implementations (even +future versions of this module) until the assignment is done. + +You are still invited to try out CBOR, and this module. This module converts Perl data structures to the Concise Binary Object Representation (CBOR) and vice versa. CBOR is a fast binary serialisation @@ -38,8 +43,10 @@ can represent something in JSON, you should be able to represent it in CBOR. -This makes it a faster and more compact binary alternative to JSON, with -the added ability of supporting serialising of perl objects. +In short, CBOR is a faster and very compact binary alternative to JSON, +with the added ability of supporting serialisation of Perl objects. (JSON +often compresses better than CBOR though, so if you plan to compress the +data later you might want to compare both formats first). The primary goal of this module is to be I and the secondary goal is to be I. To reach the latter goal it was written in C. @@ -53,7 +60,7 @@ use common::sense; -our $VERSION = 0.04; +our $VERSION = 0.05; our @ISA = qw(Exporter); our @EXPORT = qw(encode_cbor decode_cbor); @@ -224,8 +231,8 @@ =item CBOR tag 256 (perl object) The tag value C<256> (TODO: pending iana registration) will be used -to deserialise a Perl object serialised with C. See "OBJECT -SERIALISATION", below, for details. +to deserialise a Perl object serialised with C. See L, below, for details. =item CBOR tag 55799 (magic header) @@ -290,7 +297,7 @@ =item other blessed objects Other blessed objects are serialised via C or C. See -"OBJECT SERIALISATION", below, for details. +L, below, for details. =item simple scalars