X-Git-Url: https://git.korewanetadesu.com/?p=python-collate.git;a=blobdiff_plain;f=README.txt;h=eeb68b019061703f927a3921d917880ccb2b30d1;hp=c1f92369ea157c3feed1af4945a649bd072ef779;hb=b278dcabc282c5faa070a72c2e7fd915597ccd00;hpb=c2e6d9413b5780bf96302569cf641f09de90f9fa diff --git a/README.txt b/README.txt index c1f9236..eeb68b0 100644 --- 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 ------------------------------------------- @@ -10,9 +8,10 @@ Supported backends: - 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. @@ -27,7 +26,7 @@ $ sudo ./setup.py install 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