Shiran Pasternak avatar Shiran Pasternak committed 5550d58

Fixed docs.

Comments (0)

Files changed (3)

 ###client.middleware(params)
 Provides Redis-based caching for the web server. `params` is an associative list with the following supported properties:
 
-* `prefix`: *string* \[default: `web-cache`]  The prefix to use for caching. Useful for running multiple caches on the same server.
+* `prefix`: *string* \[default: `web-cache`]
+
+  The prefix to use for caching. Useful for running multiple caches on the same server.
   
-* `expire`: (*integer*) \[default: `86400`  The age of items (in seconds) at which to expire them from the cache.
+* `expire`: *integer* \[default: `86400`]
+
+  The age of items (in seconds) at which to expire them from the cache.
   
-* `path`: (*string* or *Re  The path matching routes that should be cached.
+* `path`: *string* or *RegExp* \[default: `/`]
+
+  The path matching routes that should be cached.
+
+* `exclude`: *array* of *string* or *RegExp* \[default: `null`]
+
+  A list of routes which the cache should exclude.
+
+* `host`: *string* \[default: `127.0.0.1`]
+
+  The Redis host.
 
-* `exclude`: *array* of *string  A list of routes which the cache should exclude.
+* `port`: *string* \[default: `6379`]
 
-* `host`: *string* \[default: `127.0.0.1`] The Redis host.
+  The Redis port.
 
-* `port`: *string* \[default: `6379`] The Redis port.
+* `clean`: *boolean* \[default: `false`]
 
-* `clean`: *boolean* \[default: `false`] Remove all currently-cached items.
+  Remove all currently-cached items.
 
 ##Limitations
 The following are temporary and are being implemented, or thought about.
 
-* Only supports JSON content for the moment.
 * Will not cache multiple chunks from streaming responses.
 * No limit on size or count of cached items.
-* NO TESTS! (Yet)
+* Not using Cache-Control headers at the moment.
 
 ##License
     Copyright (c) 2013 Shiran Pasternak <shiranpasternak@gmail.com>
 
 * Return "Cache-Control" response header
 * Honor "Cache-Control: no-cache" request header
-* Cache multiple content types for URL routes
             "name": "Shiran Pasternak",
            "email": "shiranpasternak@gmail.com"
           },
-         "version": "0.0.1",
+         "version": "0.0.2",
         "keywords": [ "server", "cache", "redis" ],
     "dependencies": {
            "redis": ">=0.8.2"
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.