Skip to content

Commit edd6f69

Browse files
clueclue
authored
Merge pull request #16 from clue-labs/name
Update project homepage
2 parents 786fa95 + 6e0b073 commit edd6f69

File tree

4 files changed

+56
-19
lines changed

4 files changed

+56
-19
lines changed

‎.github/FUNDING.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: clue
2+
custom: https://clue.engineering/support

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2013 Christian Lück
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
1-
# clue/redis-protocol [![Build Status](https://travis-ci.org/clue/php-redis-protocol.png?branch=master)](https://travis-ci.org/clue/php-redis-protocol)
1+
# clue/redis-protocol
22

3-
[![CI status](https://github.com/clue/php-redis-protocol/actions/workflows/ci.yml/badge.svg)](https://github.com/clue/php-redis-protocol/actions)
3+
[![CI status](https://github.com/clue/redis-protocol/actions/workflows/ci.yml/badge.svg)](https://github.com/clue/redis-protocol/actions)
44
[![installs on Packagist](https://img.shields.io/packagist/dt/clue/redis-protocol?color=blue&label=installs%20on%20Packagist)](https://packagist.org/packages/clue/redis-protocol)
55

6-
A streaming redis protocol parser and serializer written in PHP
6+
A streaming Redis protocol (RESP) parser and serializer written in pure PHP.
77

8-
This parser and serializer implementation allows you to parse redis protocol
8+
This parser and serializer implementation allows you to parse Redis protocol
99
messages into native PHP values and vice-versa. This is usually needed by a
10-
redis client implementation which also handles the connection socket.
10+
Redis client implementation which also handles the connection socket.
1111

12-
To re-iterate: This is *not* a redis client implementation. This is a protocol
13-
implementation that is usually used by a redis client implementation. If you're
12+
To re-iterate: This is *not* a Redis client implementation. This is a protocol
13+
implementation that is usually used by a Redis client implementation. If you're
1414
looking for an easy way to build your own client implementation, then this is
15-
for you. If you merely want to connect to a redis server and issue some
15+
for you. If you merely want to connect to a Redis server and issue some
1616
commands, you're probably better off using one of the existing client
1717
implementations.
1818

1919
**Table of contents**
2020

21+
* [Support us](#support-us)
2122
* [Quickstart example](#quickstart-example)
2223
* [Usage](#usage)
2324
* [Factory](#factory)
@@ -27,6 +28,16 @@ implementations.
2728
* [Install](#install)
2829
* [License](#license)
2930

31+
## Support us
32+
33+
We invest a lot of time developing, maintaining and updating our awesome
34+
open-source projects. You can help us sustain this high-quality of our work by
35+
[becoming a sponsor on GitHub](https://github.com/sponsors/clue). Sponsors get
36+
numerous benefits in return, see our [sponsoring page](https://github.com/sponsors/clue)
37+
for details.
38+
39+
Let's take these projects to the next level together! 🚀
40+
3041
## Quickstart example
3142

3243
```php
@@ -62,15 +73,15 @@ your use-case).
6273

6374
### Parser
6475

65-
The library includes a streaming redis protocol parser. As such, it can safely
66-
parse redis protocol messages and work with an incomplete data stream. For this,
76+
The library includes a streaming Redis protocol parser. As such, it can safely
77+
parse Redis protocol messages and work with an incomplete data stream. For this,
6778
each included parser implements a single method
6879
`ParserInterface::pushIncoming($chunk)`.
6980

70-
* The `ResponseParser` is what most redis client implementation would want to
71-
use in order to parse incoming response messages from a redis server instance.
72-
* The `RequestParser` can be used to test messages coming from a redis client or
73-
even to implement a redis server.
81+
* The `ResponseParser` is what most Redis client implementation would want to
82+
use in order to parse incoming response messages from a Redis server instance.
83+
* The `RequestParser` can be used to test messages coming from a Redis client or
84+
even to implement a Redis server.
7485
* The `MessageBuffer` decorates either of the available parsers and merely
7586
offers some helper methods in order to work with single messages:
7687
* `hasIncomingModel()` to check if there's a complete message in the pipeline
@@ -121,7 +132,7 @@ assert($model implement Model\MultiBulkReply);
121132
## Install
122133

123134
It's very unlikely you'll want to use this protocol parser standalone.
124-
It should be added as a dependency to your redis client implementation instead.
135+
It should be added as a dependency to your Redis client implementation instead.
125136
The recommended way to install this library is [through Composer](https://getcomposer.org).
126137
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
127138

@@ -139,4 +150,7 @@ Its parser and serializer originally used to be based on
139150
[jpd/redisent](https://github.com/jdp/redisent), which is released under the ISC
140151
license, copyright (c) 2009-2012 Justin Poliey <[email protected]>.
141152

142-
Other than that, this library is MIT licensed.
153+
Other than that, this project is released under the permissive [MIT license](LICENSE).
154+
155+
> Did you know that I offer custom development services and issuing invoices for
156+
sponsorships of releases and for contributions? Contact me (@clue) for details.

‎composer.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "clue/redis-protocol",
3-
"description": "A streaming redis wire protocol parser and serializer implementation in PHP",
4-
"keywords": ["streaming", "redis", "protocol", "parser", "serializer"],
5-
"homepage": "https://github.com/clue/php-redis-protocol",
3+
"description": "A streaming Redis protocol (RESP) parser and serializer written in pure PHP.",
4+
"keywords": ["streaming", "redis", "protocol", "resp", "parser", "serializer"],
5+
"homepage": "https://github.com/clue/redis-protocol",
66
"license": "MIT",
77
"authors": [
88
{

0 commit comments

Comments
 (0)