[Zope-CVS] CVS: Products/FileCacheManager - README.txt:1.4

[Jens Vagelpohl]

Update of /cvs-repository/Products/FileCacheManager
In directory cvs.zope.org:/tmp/cvs-serv26321

Modified Files:
	README.txt 
Log Message:
- pretty up docs


=== Products/FileCacheManager/README.txt 1.3 => 1.4 ===
--- Products/FileCacheManager/README.txt:1.3	Thu Aug 19 15:40:14 2004
+++ Products/FileCacheManager/README.txt	Sun Aug 29 11:21:36 2004
@@ -6,19 +6,38 @@
   with a File Cache Manager are stored on the file system in a hierarchy of 
   directories similar to other dedicated caching products such as Squid.
 
-  Apart from the ability to cache items on the file system the FCM has 
-  another advantage over other Zope products that store content on disk, it
-  is using the new ZPublisher file iterator for serving the file system
-  content. The file iterator serves content in a memory-conserving way
-  and it does not hold on to a ZODB database connection.
-
-  Transaction-awareness is built into the filesystem-related operations.
-  That means a file is only written out to the file system if the 
-  transaction that wants to write it commits in full. Conversely, a file
-  that is supposed to be deleted as part of an invalidation operation will
-  only be deleted if the invalidation transaction commits cleanly.
+
+  ** Features **
+
+    - Fast serving with the aid of the "filestream_iterator"
+
+      Apart from the ability to cache items on the file system the FCM has 
+      another advantage over other Zope products that store content on disk, it
+      is using the new ZPublisher file iterator for serving the file system
+      content. The file iterator serves content in a memory-conserving way
+      and it does not hold on to a ZODB database connection while 
+      streaming the data, thus freeing it earlier and allowing more
+      concurrent access to Zope. Serving speed is also improved vastly over
+      serving the data directly from the ZODB.
+
+    - Transaction awareness
+
+      Transaction-awareness is built into the filesystem-related operations.
+      That means a file is only written out to the file system if the 
+      transaction that wants to write it commits in full. Conversely, a file
+      that is supposed to be deleted as part of an invalidation operation will
+      only be deleted if the invalidation transaction commits cleanly.
+
+    - Highly configurable
+
+      All filesystem-related options can be configured using knobs in the 
+      ZMI interface, so there is full control over where the cache files are
+      written. It is also possible to directly influence the way the cache
+      files are named using a TAL expression. By default cache files are
+      named using a md5 hash of the object's path in the ZODB.
 
   ** Requirements **
 
-    - Zope version 2.7.1 or higher
+    - Zope version 2.7.1 or higher (That's the first stable Zope version to 
+      feature the filestream_iterator)