Skip to content
This repository has been archived by the owner on Nov 12, 2020. It is now read-only.

Commit

Permalink
Added new readme section and updated changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Kniest Jordan authored and Kniest Jordan committed Nov 21, 2017
1 parent fd41dd2 commit 680b5aa
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 11 deletions.
3 changes: 2 additions & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## Unreleased
## [1.0.2] - 2017-11-21
### Changed
- Sites are not being cached if they do not have a 200 status code
- Sites are not being cached if there is a validation error
Expand All @@ -20,3 +20,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Configuration file to ignore specific routes

[1.0.1]: https://github.com/jkniest/HTMLCache/compare/1.0.0...1.0.1
[1.0.2]: https://github.com/jkniest/HTMLCache/compare/1.0.1...1.0.2
34 changes: 24 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,17 @@ __One benefit against much other html caches:__ It will also cache the pages bas
2. [Using](#using)
2.1. [For all web routes](#for-all-web-routes)
2.2. [Only for specific routes](#only-for-specific-routes)
3. [Configuration](#configuration)
3.1. [Enable / Disable cache](#enable--disable-cache)
3.2. [Caching prefix](#caching-prefix)
3.3. [Caching time](#caching-time)
3.4. [User specific caching](#user-specific)
4. [Ignoring routes](#ignoring-routes)
5. [Clear cache](#clear-cache)
6. [Override middlware](#override-middlware)
7. [Roadmap](#roadmap)
8. [License](#license)
3. [When will pages not be cached?](#when-will-pages-not-be-cached)
4. [Configuration](#configuration)
4.1. [Enable / Disable cache](#enable--disable-cache)
4.2. [Caching prefix](#caching-prefix)
4.3. [Caching time](#caching-time)
4.4. [User specific caching](#user-specific)
5. [Ignoring routes](#ignoring-routes)
6. [Clear cache](#clear-cache)
7. [Override middlware](#override-middlware)
8. [Roadmap](#roadmap)
9. [License](#license)

---

Expand Down Expand Up @@ -109,6 +110,19 @@ public function __construct()
}
```

---

## When will pages not be cached?

In a few cases the pages will not be cached:

1. If the HTTP method is not `GET`
2. If the HTMLCache is disabled in the configuration
3. If the path of the current page is ignored in the configuration
4. If there are validation errors
5. If the status code is not 200


---

## Configuration
Expand Down

0 comments on commit 680b5aa

Please sign in to comment.