Added tag 0.2 Release for changeset 0a75c795453a

[python-collate.git] / README.txt

diff --git a/README.txt b/README.txt
index c1f9236..eeb68b0 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,3 @@
-This module is unsuitable for real-world use at this time.
-

 pycollate - Collation algorithms for Python
 -------------------------------------------
 
 pycollate - Collation algorithms for Python
 -------------------------------------------
 


@@ -10,9 +8,10 @@ Supported backends:
 - syslocale - Native OS collation routines.
 - codepoint - Raw Unicode codepoint comparison
 
 - syslocale - Native OS collation routines.
 - codepoint - Raw Unicode codepoint comparison
 

-The different backends have varying features and behaviors; which one
-is best depends on your goals. A specific backend can be used, or a
-"best" backend is chosen by default.
+If available, you'll probably want to use the ICU backend. If it's not
+available, syslocale should work on most Python installations. A
+specific backend can be used, or a "best" backend is chosen by
+default.

 
 pycollate also provides tools to perform word-wise and numeric sorts.
 
 
 pycollate also provides tools to perform word-wise and numeric sorts.
 


@@ -27,7 +26,7 @@ $ sudo ./setup.py install
 Example
 -------
 import collate
 Example
 -------
 import collate

-strings = file("contents.txt").read().decode("utf-8").splitlines()
+strings = open("contents.txt").read().decode("utf-8").splitlines()

 strings.sort(key=collate.key)
 
 License
 strings.sort(key=collate.key)
 
 License