Skip to content

Commit

Permalink
Configuration and example docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kpdecker committed Dec 30, 2011
1 parent 8ff2b66 commit 44f4a11
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
@@ -1,3 +1,19 @@
# Lumbar Long Expires

Lumbar plugin that provides long-expires resource loading for lumbar modules.

## Configuration

To enable this plugin a `long-expires` key must be defined on the root lumbar config
object. The value of this key is the process that is executed to generate expires
cache busting key. This could be a unique id from source control such as the git
commit sha, a timestamp, or any other value that will be unique on each build.

## Example

The following example uses the current git SHA as the unique token.

{
"modules": [],
"long-expires": "git rev-parse HEAD"
}

0 comments on commit 44f4a11

Please sign in to comment.