Updated docs

Author: bminer

README.md

@@ -1,31 +1,29 @@
 #node-static-asset
 
 node-static-asset is a static asset manager for Node.JS, designed for Express.
-This project aims to solve all application deployment problems. No thinking
-required.
+This project aims to solve the problem of caching static assets (including
+assets like *.js files that might change from time to time).
 
 ## Background
 
-Google has a nice article about strong and weak caching.  It's worth a quick
+Google has a nice article about "strong" and "weak" caching.  It's worth a quick
 read if you don't know what that means.
 
 https://developers.google.com/speed/docs/best-practices/caching
 
 ## Getting Started
 
-node-static-asset allows you to compile, bundle, minify/compress, and deploy
-your static assets. The basic idea works like this:
+node-static-asset allows you to generate URL fingerprints for static assets in
+a way that works for your application.
 
 1. Add the static-asset middleware to your Express stack
-
 ```javascript
 var staticAsset = require('static-asset');
 app.use(staticAsset(__dirname + "/public/") );
 ```
 
 2. Get URL fingerprints of your static resources using `req.assetFingerprint`
 or the `assetFingerprint` view helper function.
-
 ```javascript
 app.get("/info", function(req, res, next) {
 	res.type("text/plain").send("The URL fingerprint for jQuery is: " +
@@ -35,7 +33,9 @@ app.get("/info", function(req, res, next) {
 
 The above gives you weak and strong caching for all files served in the /public
 directory.  But, that's not all; static-asset has many more features that allow
-you to customize how files are cached and how to generate URL fingerprints.
+you to customize how files are cached and how to generate URL fingerprints. You
+can even write your own middleware that minifies JavaScript files, for example,
+and use static-asset to serve them to the browser.
 
 ## API
 
@@ -54,11 +54,13 @@ strong caching headers to the response.
 
 **"Cache Strategy" Object** - a "cache strategy" object should implement one or
 more of the following methods:
+
 	-lastModified(label_or_filename, cb) - a function that accepts a label
 		or filename and returns its last modified date to the callback.
 		If a last modified date could not be determined, null is passed to the
 		callback; otherwise, static-asset *may* use this Date to set the
 		`Last-Modified` HTTP header when the named resource is served.
+
 		-label_or_filename - a label or filename in `path`
 		-cb - a callback of the form `cb(err, lastModifiedDate)`
 	-etag(label_or_filename, cb) - Same as lastModified (above), except
@@ -77,6 +79,18 @@ strategy", return a URL fingerprint for the labelled resource, or if no such
 label is registered, attempt to locate the specified filename within the `path`
 to determine its fingerprint.
 
+**req.assetFingerprint(label, urlFingerprint, cacheInfo)** - Registers a URL
+fingerprint for the specified label.
+
+-label - a label identifying the resource
+-urlFingerprint - the URL fingerprint for the resource. If a request for this
+	resource is made, static-asset may add caching headers to the response.
+-cacheInfo - an Object containing these properties:
+	-lastModified - the last modified date of the resource
+	-etag - the ETag of the resource
+	-expires - the expiration date of the resource; if not given, the resource
+		will expire approximately one year in the future. Set to `null` to
+		disable strong caching headers.
 
 Other middleware on the stack can generate their own URL fingerprints for
 static resources and expose them through `req.assetFingerprint`. Like this:
@@ -88,13 +102,6 @@ req.assetFingerprint(javascript_filename, javascript_filename + "?v=" +
 	stat.mdate.getTime(), {"lastModified": stat.mdate});
 ```
 
-4. Customize your caching algorithms by overriding the defaults.
-
-```javascript
-var staticAsset = require('static-asset');
-app.use(staticAsset(__dirname + "/public/") );
-```
-
 ## Install
 
 `npm install static-asset`