diff -r 60b0a6b21a12 -r d4c28f4078cd docs/README.txt
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/README.txt	Wed Jul 22 17:26:34 2015 +0200
@@ -0,0 +1,30 @@
+===================
+pyams_utils package
+===================
+
+.. contents::
+
+What is pyams_utils ?
+=====================
+
+pyams_utils is a set of classes and functions which can be used to provide many small services and
+handle common operations in the context of a Pyramid application.
+
+Internal sub-packages include :
+ - date : convert dates to unicode ISO format, parse ISO datetime, convert date to datetime
+ - request : get current request, get request annotations, get and set request data via annotations
+ - timezone : convert datetime to a given timezone ; provides a server default timezone utility
+ - traversing : get object parents until a given interface is implemented
+ - unicode : convert any text to unicode for easy storage
+ - protocol : utility functions and modules for several nerwork protocols
+ - catalog : TextIndexNG index for Zope catalog and hurry.query "Text" query item
+ - text : simple text operations and text to HTML conversion
+ - html : HTML parser and HTML to text converter
+ - file : file upload data converter
+ - tal : text and HTML conversions for use from within TAL
+
+
+How to use pyams_utils ?
+========================
+
+A set of pyams_utils usages are given as doctests in pyams_utils/doctests/README.txt