final documentation tweaks

Author: AliceWonderMiscreations

INSTALL.md

@@ -17,7 +17,7 @@ If you want to use it in a project that is managed by
 `composer.json` file:
 
     "require": {
-        "awonderphp/simplecacheredis": "dev-master"
+        "awonderphp/simplecacheredis": "^1.0"
     },
 
 As long as your `composer.json` allows the [Packagist](https://packagist.org/)
@@ -38,9 +38,6 @@ your autoloader can find them first:
 Both of those libraries include exception classes that also must be installed
 where your autoloader can find them.
 
-For `AWonderPHP/SimpleCache` make sure to use the `devel` branch, it has some
-exception functions required by this class.
-
 Once those two dependencies are installed, there are two class files:
 
 1. [`SimpleCacheRedis`](lib/SimpleCacheRedis.php)

README.md

@@ -1,22 +1,6 @@
 SimpleCacheRedis
 ================
 
-An implementation of PSR-16 for Redis including encryption.
-
-This library extends
-[\AWonderPHP\SimpleCache\SimpleCache](https://github.com/AliceWonderMiscreations/SimpleCache)
-but requires the `devel` branch for updates to the exception classes.
-
-Once the `devel` branch of that project is merged into `master` and an official
-release is made, an official release of this library will be made. The current
-holdup, I am contemplating also creating a
-[memcached](https://www.memcached.org/) release and may need to make some
-additional tweaks to the exception classes for that as well.
-
-Though not tagged as an official release, this should be considered stable.
-
----------------------------------------------------------------------------
-
 This is an implementation of [PSR-16](https://www.php-fig.org/psr/psr-16/) for
 the Redis caching engine.
 

SODIUM.md

@@ -251,7 +251,7 @@ I do not *believe* PHP caches the contents of files read with
 `file_get_contents()` (I could be wrong about that) so storing the secret key
 in a configuration file is safer.
 
-The class reads the file into a JSON string and then converts it an object.
+The class reads the file into a JSON string and then converts it to an object.
 The JSON string is then zeroed out using `sodium_memzero()` function.
 
 Once they key has been verified as an actual working key, the key is set as a

USAGE.md

@@ -33,8 +33,9 @@ For simple cases where Redis is running on the same server, this usually works:
     $redis = new \Redis();
     $redis->connect('127.0.0.1', 6379);
 
-If you need more complexity than that, see the PECL class documentation. Once
-you have that object, you can create an instance of the `SimpleCacheRedis`
+If you need more complexity than that, see the
+[PECL Connection documentation](https://github.com/phpredis/phpredis/#connection).
+Once you have that object, you can create an instance of the `SimpleCacheRedis`
 class.
 
 The easiest way to create an object of the `SimpleCacheRedis` class:
@@ -338,8 +339,7 @@ This allows you to specify the default number of seconds to use for the TTL
 when it is not specified in the `set()` or `setMultiple()` methods.
 
 By default, the value is `0` which tells Redis to keep the `key => value`
-pair in cache until the server daemon is restarted or until the memory is
-needed for something else.
+pair in cache until you specifically replace it or specifically delete it.
 
 Personally I think that rarely is a good idea. Web applications _SHOULD_
 either delete the cached entry or update the cached entry when the data is
@@ -376,11 +376,13 @@ It is needed for unit testing.
 Exceptions
 ----------
 
-There are two conditions that can cause SimpleCacheRedis to intentionally throw
-an exception:
+There are three conditions that can cause SimpleCacheRedis to intentionally
+throw an exception:
 
 1. The data type used in a parameter is incorrect
 2. The data used in a parameter is not valid for use
+3. There is an issue connecting with the Redis server or if you are using the
+Sodium variant, there is an issue that will prevent encryption from working.
 
 ### Data Type Exceptions
 
@@ -424,7 +426,27 @@ In those circumstances, this class will throw a:
 
 Exception.
 
-You can catch these based on `InvalidArgumentException` or the PSR implementation.
+You can catch these based on `\InvalidArgumentException` or the PSR
+implementation.
+
+
+### Setup Exceptions
+
+Exceptions of this type only happen when either the class is not able to
+connect to the Redis server, you are using the Sodium variant and do not have
+the libsodium functions available, you specified a JSON configuration file that
+does not exist or is invalid, your encryption key is not valid, or something is
+broken resulting in the encryption nonce not being properly incremented.
+
+In those circumstances, this class will throw a:
+
+    \AWonderPHP\SimpleCache\InvalidSetupException
+        extends \ErrorException
+        implements \Psr\SimpleCache\CacheException
+
+Exception.
+
+You can catch these based on `\ErrorException` or the PSR implementation.
 
 
 ### About Catching Exceptions