Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Serby committed Dec 15, 2011
1 parent 41e897e commit 0270e73
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
@@ -1,19 +1,18 @@

# versionator - Static content versioning middleware for connect.

versionator was built to solve the problem of static assests getting stuck in browser and proxy caches when new version of the assets are deployed.
versionator was built to solve the problem of static assests getting stuck in browser and proxy caches when new versions of the assets are deployed.

Without versionator this is what can happen:

You set your static content to be cached and expire in 1 months time. This gives you more capacity on your web servers and a great rating on Google Page Speed and ySlow.
You set your static content to be cached and expire in 1 months time. This gives you more capacity on your web servers and a great rating on Google Pagespeed and ySlow.

You deploy your site an all is good.
You deploy your site and all is good.

Then you need to change sprite.png

You make your changes and redeploy sprite.png. The trouble now is that everyone who has looked at your site already has the old version in their browser cache. Not only that, any upstream proxies will also have a copy.

A possible solution is to rename your static assest every time you change them, but that in impractical as you also have to update all the references each time they change. If you have a single CSS sprite then this is a real pain.
A possible solution is to rename your static assest every time you change them, but that is impractical as you also have to update all the references each time they change. If you have a single CSS sprite then this is a real pain.

A better solution is to use versionator!

Expand Down Expand Up @@ -64,7 +63,7 @@ will become:

/js/app.js

Now all you need to do is increment app.version each deployment (We keep ours inline with our git tags using a build tool) then site back and let your users enjoy the freshness.
Now all you need to do is increment app.version each deployment (We keep ours inline with our git tags using Cake the coffee-script build tool) then sit back and let your users enjoy the freshness.


## Credits
Expand Down

0 comments on commit 0270e73

Please sign in to comment.