Skip to content

Commit

Permalink
Explain caching better in Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jschall committed Jun 23, 2013
1 parent 9643e8b commit 65e0e45
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,8 @@ cons[name]('views/page.html', { user: 'tobi' }, function(err, html){
## Caching

To enable caching simply pass `{ cache: true }`. Engines _may_ use this option to cache things reading the file contents, compiled `Function`s etc. Engines which do _not_ support this may simply ignore it. All engines that consolidate.js implements I/O for will cache the file contents, ideal for production environments.

```js
var cons = require('consolidate');
cons.swig('views/page.html', { user: 'tobi' }, function(err, html){
if (err) throw err;
console.log(html);
});
```
When using consolidate directly: `cons.swig('views/page.html', { user: 'tobi', cache:true },callback);`
Using Express 3 or higher: `app.locals.cache = true` or set NODE_ENV to 'production' and Express will do this for you.

## Express 3.x example

Expand Down

0 comments on commit 65e0e45

Please sign in to comment.