More release preparation. Docstrings and consistency work.
[python-collate.git] / setup.py
index 111cfac..99a13af 100755 (executable)
--- a/setup.py
+++ b/setup.py
@@ -11,7 +11,7 @@ else:
     libraries = ['icui18n', 'icuuc', 'icudata']
 
 setup(name='collate',
-      version='0',
+      version='0.1',
       author="Joe Wreschnig",
       author_email="joe.wreschnig@gmail.com",
       description="Python text collation",
@@ -22,4 +22,14 @@ setup(name='collate',
                     libraries=libraries)],
       cmdclass=dict(build_ext=build_ext),
       packages=["collate", "collate.icu"],
+      long_description="""\
+This module provides tools to sort strings in a 'human-expected'
+order. Because human expectations are fuzzy and often
+self-contradictory, the sort order is not guaranteed to be stable
+between versions of this module (rather the opposite - the primary
+reason to update it will probably be changed sort results). If
+available, this module uses the ICU localization library. Otherwise,
+it uses the system's locale database (and produces significantly worse
+results).
+"""
       )