From 90effcbefc28cd5d6a852376fa1f0e6f562bc52c Mon Sep 17 00:00:00 2001 From: Nasreddine Bouafif Date: Mon, 23 Nov 2009 14:52:34 +0100 Subject: [PATCH] Documentation format --- README.markdown | 40 +++++++++++++++++----------------------- 1 file changed, 17 insertions(+), 23 deletions(-) diff --git a/README.markdown b/README.markdown index 3987086..39a662a 100644 --- a/README.markdown +++ b/README.markdown @@ -1,40 +1,35 @@ PhpRedis ============= -Introduction ------------- +### Introduction + +### Installing/Configuring -Installing/Configuring ----------------------- * Requirements * Installation * Runtime Configuration * Resource Types -Predefined Constants --------------------- -Examples --------- +### Predefined Constants + +### Examples + * overview example -PhpRedis Functions ------------------- - -* Redis::set +### PhpRedis Functions * Redis::get -# (@version) -# [mini description] -Get the value related to key -# [description] -# [Parameters] -## key -# Return Value -# Examples +Get the value related to the specified key +**Parameters +key : key +** Return Value +If key didn't exist, False is returned. Else, the value related to this key is returned. +** Examples +$redis->get('key'); + +* Redis::set * Redis::setnx - - * Redis::del * Redis::exists * Redis::incr @@ -57,7 +52,6 @@ Get the value related to key * Redis::scard * Redis::spop * Redis::sinter - * Redis::sinterstore * Redis::sunion * Redis::sunionstore