Skip to content

Commit

Permalink
Prepare v1.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
clue committed Dec 6, 2020
1 parent 9d045b0 commit a81d0b9
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 18 deletions.
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github: clue
custom: https://clue.engineering/support
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Changelog

## 1.1.0 (2020-12-06)

* Feature: Forward compatibility with stable EventLoop 1.0 and 0.5.
(#11 by @clue)

* Improve documentation and add API docs (docblocks).
(#10 and #12 by @clue)

* Improve test suite and add `.gitattributes` to exclude dev files from export.
Update to PHPUnit 9 and simplify test setup.
(#8, #9, #17 and #18 by @clue and #15 by @SimonFrings)

## 1.0.0 (2016-03-07)

* First stable release, now following SemVer
Expand Down
48 changes: 32 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,38 @@

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

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

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

Among others, multicast networking is the basis for:

* MDNS (Multicast DNS)
* HTTPU/HTTPMU (Multicast and Unicast UDP HTTP Messages)
* UPNP/SSDP (Univeral Plug and Play / Simple Service Discovery Protocol).

**Table of Contents**
**Table of contents**

* [Support us](#support-us)
* [Quickstart example](#quickstart-example)
* [Usage](#usage)
* [Factory](#factory)
* [createSender()](#createsender)
* [createReceiver()](#createreceiver)
* [SocketInterface](#socketinterface)
* [Factory](#factory)
* [createSender()](#createsender)
* [createReceiver()](#createreceiver)
* [SocketInterface](#socketinterface)
* [Install](#install)
* [Tests](#tests)
* [License](#license)

## Support us

We invest a lot of time developing, maintaining and updating our awesome
open-source projects. You can help us sustain this high-quality of our work by
[becoming a sponsor on GitHub](https://github.com/sponsors/clue). Sponsors get
numerous benefits in return, see our [sponsoring page](https://github.com/sponsors/clue)
for details.

Let's take these projects to the next level together! 🚀

## Quickstart example

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

## Install

The recommended way to install this library is [through Composer](http://getcomposer.org).
[New to Composer?](http://getcomposer.org/doc/00-intro.md)
The recommended way to install this library is [through Composer](https://getcomposer.org).
[New to Composer?](https://getcomposer.org/doc/00-intro.md)

This project follows [SemVer](https://semver.org/).
This will install the latest supported version:

```bash
$ composer require clue/multicast-react:~1.0
$ composer require clue/multicast-react:^1.1
```

See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.

This project aims to run on any platform and thus does not require any PHP
extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
HHVM.
Expand All @@ -169,4 +182,7 @@ $ php vendor/bin/phpunit

## License

MIT
This project is released under the permissive [MIT license](LICENSE).

> Did you know that I offer custom development services and issuing invoices for
sponsorships of releases and for contributions? Contact me (@clue) for details.
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "clue/multicast-react",
"description": "Simple multicast UDP message client and server for ReactPHP.",
"description": "Simple, event-driven multicast UDP message client and server for ReactPHP.",
"keywords": ["multicast", "mcast", "udp", "ReactPHP", "async"],
"homepage": "https://github.com/clue/reactphp-multicast",
"license": "MIT",
"authors": [
{
"name": "Christian Lück",
"email": "christian@lueck.tv"
"email": "christian@clue.engineering"
}
],
"autoload": {
Expand Down

0 comments on commit a81d0b9

Please sign in to comment.