Upgrade to Unicode::Normalize 0.21 and Unicode::Collate 0.24,

[p5sagit/p5-mst-13.2.git] / lib / Unicode / Collate / README

diff --git a/lib/Unicode/Collate/README b/lib/Unicode/Collate/README
index bf0efff..fc0f68f 100644 (file)
--- a/lib/Unicode/Collate/README
+++ b/lib/Unicode/Collate/README
@@ -1,33 +1,28 @@
-Unicode/Collate version 0.07
+Unicode/Collate version 0.24
 ===============================
 
-use UCA (Unicode Collation Algorithm)
+NAME
 
-  See UCA - Unicode TR #10.
-  http://www.unicode.org/unicode/reports/tr10/
-
-  Fetch the following file before use and put it into the Unicode/Collate dir.
-  http://www.unicode.org/unicode/reports/tr10/allkeys.txt
-
-  You can install this module using a subset "keys.txt"
-  contained in this distribution without the "allkeys.txt".
+  Unicode::Collate - Unicode Collation Algorithm
 
 SYNOPSIS
 
   use Unicode::Collate;
 
   #construct
-  $UCA = Unicode::Collate->new(%tailoring);
+  $Collator = Unicode::Collate->new(%tailoring);
 
   #sort
-  @sorted = $UCA->sort(@not_sorted);
+  @sorted = $Collator->sort(@not_sorted);
 
   #compare
-  $result = $UCA->cmp($a, $b); # returns 1, 0, or -1.
+  $result = $Collator->cmp($a, $b); # returns 1, 0, or -1.
+  $result = $Collator->eq($a, $b);  # returns true/false
+    (similarly ->ne, ->lt, ->le, ->gt, ->ge)
 
 INSTALLATION
 
-Perl 5.006 or later
+Perl 5.6.1 or later
 
 To install this module type the following:
 
@@ -36,25 +31,31 @@ To install this module type the following:
    make test
    make install
 
-DEPENDENCIES
+To use this module, it is better to install a table file in the UCA format,
+by copying it into the lib/Unicode/Collate directory.
 
-This module requires these other modules and libraries:
+The most preferable one is "The Default Unicode Collation Element Table",
+available from the Unicode consortium's website:
 
-Carp
-Exporter
-Lingua::KO::Hangul::Util
+    http://www.unicode.org/reports/tr10/allkeys.txt
+
+Though this distribution contains a subset of allkeys.txt, named "keys.txt",
+this one is intended only for doing a test of this module
+and practically useless for any other purpose.
+
+DEPENDENCIES
 
-It's better if Unicode::Normalize has been installed
-although Unicode::Collate can be used without Unicode::Normalize.
+  The conformant collation requires Unicode::Normalize (v 0.10 or later)
+  although Unicode::Collate can be used without Unicode::Normalize.
 
 COPYRIGHT AND LICENCE
 
-SADAHIRO Tomoyuki <bqw10602@nifty.com>
+SADAHIRO Tomoyuki <SADAHIRO@cpan.org>
 
   http://homepage1.nifty.com/nomenclator/perl/
 
-  Copyright(C) 2001, SADAHIRO Tomoyuki. Japan. All rights reserved.
+  Copyright(C) 2001-2002, SADAHIRO Tomoyuki. Japan. All rights reserved.
 
-  This program is free software; you can redistribute it and/or 
-  modify it under the same terms as Perl itself.
+  This library is free software; you can redistribute it
+  and/or modify it under the same terms as Perl itself.