Skip to content

Commit

Permalink
Fix basic documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
LeoColomb committed Dec 29, 2018
1 parent 92fe9cd commit c81da44
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,31 @@
> A persistent cache backend powered by Redis.
[![Build Status](https://travis-ci.com/LeoColomb/wp-redis.svg?branch=master)](https://travis-ci.com/LeoColomb/wp-redis)
[![Packagist](https://img.shields.io/packagist/v/LeoColomb/wp-redis.svg)](https://packagist.org/packages/LeoColomb/wp-redis)

## Features

* Enable the two cache wrappers for WordPress
* Object cache
* Page cache
* Enables the two cache wrappers for WordPress
* Object Cache ([`object-cache.php`](dropins/object-cache.php))
* Advanced Page Cache ([`advanced-cache.php`](dropins/advanced-cache.php))
* Adds handy [WP-CLI](https://wp-cli.org/) commands
* `wp redis status`: Show the Redis cache status and (when possible) client.
* `wp redis flush`: Flush the Redis cache, clear all data.
* Supports major PHP Redis drivers
* [Predis](https://github.com/nrk/predis/)
* [PhpRedis (PECL)](https://github.com/phpredis/phpredis)
* Supports replication and clustering
* Targets modern software stacks


## Installation

* Prepare your Composer file
* Prepare your Composer file by adding custom paths ([more info](https://github.com/Koodimonni/Composer-Dropin-Installer#readme))
```json
{
"extra": {
"dropin-paths": {
"web/app/": [
"htdocs/wp-content/": [
"package:leocolomb/wp-redis:dropins/object-cache.php",
"package:leocolomb/wp-redis:dropins/advanced-cache.php"
]
Expand All @@ -37,6 +41,7 @@
$ composer require leocolomb/wp-redis
```


## Configuration

To adjust the configuration, define any of the following constants in your `wp-config.php` file.
Expand Down Expand Up @@ -107,6 +112,7 @@ define('WP_REDIS_CLUSTER', [
]);
```


## License

GPL-3.0 © [Léo Colombaro](https://colombaro.fr)
Expand Down

0 comments on commit c81da44

Please sign in to comment.