Update documentation

Fixes #88

Author: mikebronner

CHANGELOG.md

@@ -4,6 +4,14 @@ 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).
 
+## [0.2.38] - 24 Feb 2018
+### Added
+- cache-invalidation-cool-down functionality.
+
+## [0.2.37] - 23 Feb 2018
+### Added
+- disabling of `->all()` method caching via config flag.
+
 ## [0.2.36] - 23 Feb 2018
 ### Added
 - config setting to allow disabling of model-caching.
@@ -15,6 +23,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - caching for `paginate()`;
 
+## [0.2.34] - 21 Feb 2018
+### Added
+- implementation tests using redis.
+- additional tests for some edge case scenarios.
+
+### Fixed
+- cache key prefix functionality.
+
+### Updated
+- tests through refactoring and cleaning up.
+
 ## [0.2.33] - 19 Feb 2018
 ### Added
 - unit test to make sure `Model::all()` returns a collection when only only

README.md

@@ -41,7 +41,7 @@ environment variable in your `.env` file to the name of a cache store configured
 in `config/cache.php` (you can define any custom cache store based on your
 specific needs there). For example:
 ```
-MODEL_CACHE_STORE=redis
+MODEL_CACHE_STORE=redis2
 ```
 
 ## Usage
@@ -105,7 +105,20 @@ extends `Illuminate\Foundation\Auth\User`. Overriding that would break functiona
 Not only that, but it probably isn't a good idea to cache the user model anyway,
 since you always want to pull the most up-to-date info on it.
 
-### Optional Disabling Caching of Queries
+### Experimental: Cache Cool-down In Specific Models
+In some instances, you may want to add a cache invalidation cool-down period.
+For example you might have a busy site where comments are submitted at a high
+rate, and you don't want every comment submission to invalidate the cache. While
+I don't necessarily recommend this, you might experiment it's effectiveness.
+
+It can be implemented like so:
+```php
+(new Comment)
+    ->withCacheCooldownSeconds(30)
+    ->get();
+```
+
+### Disabling Caching of Queries
 There are two methods by which model-caching can be disabled:
 1. Use `->disableCache()` in a query-by-query instance.
 2. Set `MODEL_CACHE_DISABLED=TRUE` in your `.env` file.