diff README.txt @ 4:6ec33e2ce60f

more documentation
author k0s <k0scist@gmail.com>
date Sat, 06 Mar 2010 13:22:31 -0500
parents 2be0070c6f95
children c89738f3f417
line wrap: on
line diff
--- a/README.txt	Sat Mar 06 13:11:46 2010 -0500
+++ b/README.txt	Sat Mar 06 13:22:31 2010 -0500
@@ -8,9 +8,24 @@
 API
 ---
 
+cropresize contains one useful function, ``cropresize.crop_resize``.
+The function takes three arguments:
+
+    * image: a PIL image object
+    * size: a 2-tuple of (width,height);  at least one must be specified
+    * exact_size: whether to scale up for smaller images  
+
+See ``cropresize.crop_resize.__doc__`` for the function
+documentation.  ``crop_resize`` returns the cropped and resized PIL image.
+
+
 Command Line
 ------------
 
 The command line program, ``crop-resize``, is included in this python
 package.  The help for the program is displayed by running
 ``crop-resize`` with no arguments or ``crop-resize --help``.
+
+--
+
+http://k0s.org/portfolio/software.html#cropresize