forked from walmartlabs/lumbar-long-expires
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" | ||
} |