From a65f0fdda2eeac80f8b1256bd6145fc6e0c3842f Mon Sep 17 00:00:00 2001
From: Erick Hitter <ehitter@gmail.com>
Date: Wed, 27 Aug 2014 21:54:41 -0700
Subject: [PATCH] Readme!

---
 readme.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..1463717
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,19 @@
+## Overview
+
+Store WordPress user session tokens in Redis rather than the usermeta table. Requires PECL Redis library.
+
+## Authors
+
+* Erick Hitter
+
+## Installation
+1. Install and configure Redis. There is a good tutorial [here](http://www.saltwebsites.com/2012/install-redis-245-service-centos-6).
+2. Install the [Redis PECL module](http://pecl.php.net/package/redis).
+3. Activate the plugin network-wide or by placing it in `mu-plugins`.
+4. By default, the script will connect to Redis at 127.0.0.1:6379. See the *Connecting to Redis* section for further options.
+
+### Connecting to Redis ###
+
+By default, the plugin uses `127.0.0.1` and `6379` as the default host and port when creating a new client instance; the default database of `0` is also used. Three constants are provided to override these default values.
+
+Specify `WP_REDIS_BACKEND_HOST`, `WP_REDIS_BACKEND_PORT`, and `WP_REDIS_BACKEND_DB` to set the necessary, non-default connection values for your Redis instance.
-- 
GitLab