Skip to content

Commit 0228b02

Browse files
committed
Update README.md
1 parent 09fa5c3 commit 0228b02

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

README.md

+15-18
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,33 @@
11
# clue/redis-server [![Build Status](https://travis-ci.org/clue/php-redis-server.svg?branch=master)](https://travis-ci.org/clue/php-redis-server)
22

3-
A redis server implementation in pure PHP. *Not for the faint-hearted.*
3+
A Redis server implementation in pure PHP. *Not for the faint-hearted.*
44

55
> Note: This project is in early alpha stage! Feel free to report any issues you encounter.
66
77
## Introduction
88

9-
109
### Motivation
1110

12-
This project aims to provide a simple alternative to the official redis server
11+
[Redis](http://redis.io/) is a fast in-memory key-value database.
12+
This project aims to provide a simple alternative to the official Redis server
1313
implementation if installing it is not an option.
1414

15-
Why would I use this project if I already have the official redis server
15+
Why would I use this project if I already have the official Redis server
1616
installed? Simply put, you wouldn't. Ever.
1717

1818
### Project goals
1919

20-
* ✓ Implement an in-memory datastore using the redis protocol
21-
* ✓ Compatiblity with common redis clients
20+
* ✓ Implement an in-memory datastore using the Redis protocol
21+
* ✓ Compatiblity with common Redis clients and tools
2222
* ✓ redis-cli
2323
* ✓ redis-benchmark
2424
* ✓ SOLID and modern design, tested and modular components
2525
* ✗ Implement *all* commands (see below for list of supported commands)
26-
* ✗ Compatibility with common tools resque(-php) etc.
2726

2827
### Supported commands
2928

3029
Eventually, this project aims to replicate *all* commands of
31-
the [official redis server](http://redis.io/) implementation and their exact
30+
the [official Redis server](http://redis.io/) implementation and their exact
3231
behavior.
3332

3433
So far, the following list of commands shows what's already implemented:
@@ -98,21 +97,21 @@ So far, the following list of commands shows what's already implemented:
9897
* TIME
9998

10099
For details, refer to the excellent official documentation of
101-
[redis commands](http://redis.io/commands).
100+
[Redis commands](http://redis.io/commands).
102101

103102
All available commands are expected to behave just like their counterparts in
104-
redis v2.6, unless otherwise noted. If you find a command to misbehave, don't
103+
Redis v2.6+, unless otherwise noted. If you find a command to misbehave, don't
105104
hesitate to file a bug.
106105

107106
Obviously, this list is incomplete in that it does not include *every* command
108-
supported by redis. If you find a command is missing, please submit a PR :)
107+
supported by Redis. If you find a command is missing, please submit a PR :)
109108

110109
### Benchmarking performance
111110

112111
> As usual, just about *every* benchmark is biased - you've been warned.
113112
114113
You can use the `redis-benchmark` script that is included when installing the
115-
official redis server.
114+
official Redis server.
116115

117116
```bash
118117
$ redis-benchmark -p 1337 -q
@@ -154,7 +153,7 @@ performance:
154153
Disabled debugging output significantly improves performance (3x)
155154
- The benchmark should not be run from within a virtual machine. Running this on
156155
the host machine instead shows significant improvements (8x). For comparision,
157-
the same applies to official redis, although it shows a smaller impact (3x).
156+
the same applies to official Redis, although it shows a smaller impact (3x).
158157

159158
## Quickstart example
160159

@@ -168,8 +167,7 @@ Alternatively, you can also use this project as a lib in order to build your
168167
own server like this:
169168

170169
```php
171-
172-
$factory = new Factory($loop, $connector);
170+
$factory = new Factory($loop);
173171
$factory->createServer('localhost:1337')->then(function (Server $server) use ($loop) {
174172
$server->on('connection', function(Client $client) {
175173
echo $client->getRemoteAddr() .' connected' . PHP_EOL;
@@ -186,8 +184,8 @@ its dependencies [through composer](http://getcomposer.org). [New to composer?](
186184

187185
```bash
188186
$ sudo apt-get install php5-cli git curl
189-
$ git clone https://github.com/clue/redis-server.git
190-
$ cd redis-server/
187+
$ git clone https://github.com/clue/php-redis-server.git
188+
$ cd php-redis-server/
191189
$ curl -s https://getcomposer.org/installer | php
192190
$ php composer.phar install
193191
```
@@ -204,4 +202,3 @@ $ docker run -d clue/php-redis-server
204202
## License
205203

206204
MIT
207-

0 commit comments

Comments
 (0)