Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
boldenamsterdam authored Aug 22, 2018
1 parent 910668c commit 05cd9f8
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,37 @@

Cache pages to HTML and boost website performance.

This plugin generates static HTML files from your dynamic Craft CMS project. After a HTML file is generated, your webserver will serve that file instead of processing heavier and slower PHP scripts.

99% of your visitors will be served static HTML files. A cached file can be served thousands of times. That 1% could be a POST request (like AJAX forms) and btw:

* sections with a login won’t work
* the admin panel is also NOT cached


## Requirements

This plugin requires Craft CMS 3 or later.
This plugin only requires Craft CMS 3 or later.


## HTML Cache Overview

Creates a HTML Cached page for any non-cp GET request for the duration of one hour (configurable) or until an entry has been updated.
To work in DEV-mode use the force option in the settings.
To work in DEV-mode: use the force option in the settings.


## Configuring HTML Cache

Use the plugin settings to configure it.


## Using HTML Cache

HTML Cache has a settings page where you can enable/disable cache.
HTML Cache has a settings page where you can enable/disable and flush cache.


## Credits

Brought to you by [Bolden B.V.](http://www.bolden.nl)
Made with ❤️ by [Bolden](http://www.bolden.nl) – It's free to use, but if you insist 😄 donate [here](https://www.paypal.me/boldenamsterdam)

Based on https://github.com/craftapi/htmlcache
Based – but rewritten, on the HTML Cache by CraftAPI in 2016

0 comments on commit 05cd9f8

Please sign in to comment.