Updated README to accurately describe the 'max' property

isaacs · Jan 15, 2013 · dd1c085 · dd1c085
1 parent 3751bd0
commit dd1c085
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -26,7 +26,8 @@ away.
 
 ## Options
 
-* `max` The maximum number of items.  Not setting this is kind of
+* `max` The maximum size of the cache, checked by applying the length
+  function to all values in the cache.  Not setting this is kind of
   silly, since that's the whole purpose of this lib, but it defaults
   to `Infinity`.
 * `maxAge` Maximum age in ms.  Items are not pro-actively pruned out