Skip to content

Commit a81d0b9

Browse files
committed
Prepare v1.1.0 release
1 parent 9d045b0 commit a81d0b9

File tree

4 files changed

+48
-18
lines changed

4 files changed

+48
-18
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

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Changelog
22

3+
## 1.1.0 (2020-12-06)
4+
5+
* Feature: Forward compatibility with stable EventLoop 1.0 and 0.5.
6+
(#11 by @clue)
7+
8+
* Improve documentation and add API docs (docblocks).
9+
(#10 and #12 by @clue)
10+
11+
* Improve test suite and add `.gitattributes` to exclude dev files from export.
12+
Update to PHPUnit 9 and simplify test setup.
13+
(#8, #9, #17 and #18 by @clue and #15 by @SimonFrings)
14+
315
## 1.0.0 (2016-03-07)
416

517
* First stable release, now following SemVer

README.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,38 @@
22

33
[![CI status](https://github.com/clue/reactphp-multicast/workflows/CI/badge.svg)](https://github.com/clue/reactphp-multicast/actions)
44

5-
Simple multicast UDP message client and server for [ReactPHP](https://reactphp.org/).
5+
Simple, event-driven multicast UDP message client and server for [ReactPHP](https://reactphp.org/).
66

77
Multicast UDP messages are needed for quite a few (low-level) networking protocols.
8+
Among others, multicast networking is the basis for mDNS (Multicast DNS),
9+
HTTPMU (Multicast UDP HTTP Messages), UPnP/SSDP (Universal Plug and Play /
10+
Simple Service Discovery Protocol) and others.
811
This library exposes a simple subset of commonly needed functionality for
912
multicast networking through an easy to use API.
1013

11-
Among others, multicast networking is the basis for:
12-
13-
* MDNS (Multicast DNS)
14-
* HTTPU/HTTPMU (Multicast and Unicast UDP HTTP Messages)
15-
* UPNP/SSDP (Univeral Plug and Play / Simple Service Discovery Protocol).
16-
17-
**Table of Contents**
14+
**Table of contents**
1815

16+
* [Support us](#support-us)
1917
* [Quickstart example](#quickstart-example)
2018
* [Usage](#usage)
21-
* [Factory](#factory)
22-
* [createSender()](#createsender)
23-
* [createReceiver()](#createreceiver)
24-
* [SocketInterface](#socketinterface)
19+
* [Factory](#factory)
20+
* [createSender()](#createsender)
21+
* [createReceiver()](#createreceiver)
22+
* [SocketInterface](#socketinterface)
2523
* [Install](#install)
2624
* [Tests](#tests)
2725
* [License](#license)
2826

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

3139
Once [installed](#install), you can use the following code to create a simple
@@ -136,13 +144,18 @@ Please refer to the [datagram documentation](https://github.com/reactphp/datagra
136144

137145
## Install
138146

139-
The recommended way to install this library is [through Composer](http://getcomposer.org).
140-
[New to Composer?](http://getcomposer.org/doc/00-intro.md)
147+
The recommended way to install this library is [through Composer](https://getcomposer.org).
148+
[New to Composer?](https://getcomposer.org/doc/00-intro.md)
149+
150+
This project follows [SemVer](https://semver.org/).
151+
This will install the latest supported version:
141152

142153
```bash
143-
$ composer require clue/multicast-react:~1.0
154+
$ composer require clue/multicast-react:^1.1
144155
```
145156

157+
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
158+
146159
This project aims to run on any platform and thus does not require any PHP
147160
extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
148161
HHVM.
@@ -169,4 +182,7 @@ $ php vendor/bin/phpunit
169182

170183
## License
171184

172-
MIT
185+
This project is released under the permissive [MIT license](LICENSE).
186+
187+
> Did you know that I offer custom development services and issuing invoices for
188+
sponsorships of releases and for contributions? Contact me (@clue) for details.

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
22
"name": "clue/multicast-react",
3-
"description": "Simple multicast UDP message client and server for ReactPHP.",
3+
"description": "Simple, event-driven multicast UDP message client and server for ReactPHP.",
44
"keywords": ["multicast", "mcast", "udp", "ReactPHP", "async"],
55
"homepage": "https://github.com/clue/reactphp-multicast",
66
"license": "MIT",
77
"authors": [
88
{
99
"name": "Christian Lück",
10-
"email": "christian@lueck.tv"
10+
"email": "christian@clue.engineering"
1111
}
1212
],
1313
"autoload": {

0 commit comments

Comments
 (0)