Skip to content

Commit b44fa17

Browse files
author
Tit Petric
committed
consistent heading markdown, test description header
1 parent 8ffec24 commit b44fa17

File tree

1 file changed

+15
-20
lines changed

1 file changed

+15
-20
lines changed

README.markdown

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
PhpRedis
2-
========
1+
# PhpRedis
32

43
The phpredis extension provides an API for communicating with the [Redis](http://redis.io/) key-value store. It is released under the [PHP License, version 3.01](http://www.php.net/license/3_01.txt).
54
This code has been developed and maintained by Owlient from November 2009 to March 2011.
65

76
You can send comments, patches, questions [here on github](https://github.com/nicolasff/phpredis/issues) or to [email protected] ([@yowgi](http://twitter.com/yowgi)).
87

98

10-
Table of contents
11-
=================
9+
# Table of contents
1210

1311
1. [Installing/Configuring](#installingconfiguring)
1412
* [Installation](#installation)
@@ -29,8 +27,7 @@ Table of contents
2927
* Transactions
3028

3129

32-
Installing/Configuring
33-
======================
30+
# Installing/Configuring
3431

3532
1. [Installation](#installation)
3633
1. [Installation on OSX](#installation-on-osx)
@@ -39,8 +36,8 @@ Installing/Configuring
3936
1. [Error handling](#error-handling)
4037

4138

42-
Installation
43-
------------
39+
## Installation
40+
4441
<pre>
4542
phpize
4643
./configure [--enable-redis-igbinary]
@@ -54,8 +51,8 @@ You can generate a debian package for PHP5, accessible from Apache 2 by running
5451

5552
This extension exports a single class, `Redis` (and `RedisException` used in case of errors). Check out https://github.com/ukko/phpredis-phpdoc for a PHP stub that you can use in your IDE for code completion.
5653

57-
Installation on OSX
58-
-------------------
54+
55+
## Installation on OSX
5956

6057
If the install fails on OSX, type the following commands in your shell before trying again:
6158
<pre>
@@ -73,8 +70,8 @@ Taken from [Compiling phpredis on Zend Server CE/OSX ](http://www.tumblr.com/tag
7370

7471
See also: [Install Redis & PHP Extension PHPRedis with Macports](http://www.lecloud.net/post/3378834922/install-redis-php-extension-phpredis-with-macports).
7572

76-
PHP Session handler
77-
-------------------
73+
74+
## PHP Session handler
7875

7976
phpredis can be used to store PHP sessions. To do this, configure `session.save_handler` and `session.save_path` in your php.ini to tell phpredis where to store the sessions:
8077
<pre>
@@ -95,25 +92,23 @@ Sessions have a lifetime expressed in seconds and stored in the INI variable "se
9592
The session handler requires a version of Redis with the `SETEX` command (at least 2.0).
9693

9794

98-
Distributed Redis Array
99-
-----------------------
95+
## Distributed Redis Array
10096

10197
See [dedicated page](https://github.com/nicolasff/phpredis/blob/master/arrays.markdown#readme).
10298

10399

104-
Error handling
105-
--------------
100+
## Error handling
106101

107102
phpredis throws a `RedisException` object if it can't reach the Redis server. That can happen in case of connectivity issues, if the Redis service is down, or if the redis host is overloaded. In any other problematic case that does not involve an unreachable server (such as a key not existing, an invalid command, etc), phpredis will return `FALSE`.
108103

109104

110-
Methods
111-
=======
105+
# Methods
106+
107+
## General
112108

113109
### Redis::__construct
114110
-----
115-
116-
Creates a Redis client
111+
**Description**: Creates a Redis client
117112

118113
##### *Example*
119114

0 commit comments

Comments
 (0)