add max param on set to readme

isaacs · Apr 15, 2015 · faae15c · faae15c
1 parent fe333ca
commit faae15c
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -54,11 +54,12 @@ away.
 
 ## API
 
-* `set(key, value)`
+* `set(key, value, max)`
 * `get(key) => value`
 
     Both of these will update the "recently used"-ness of the key.
-    They do what you think.
+    They do what you think. `max` is optional and overrides the
+    cache `max` option if provided.
 
 * `peek(key)`