diff --git a/README.md b/README.md index 1b937cf..148f5fd 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # clue/reactphp-ssdp -[![CI status](https://github.com/clue/reactphp-ssdp/workflows/CI/badge.svg)](https://github.com/clue/reactphp-ssdp/actions) +[![CI status](https://github.com/clue/reactphp-ssdp/actions/workflows/ci.yml/badge.svg)](https://github.com/clue/reactphp-ssdp/actions) [![installs on Packagist](https://img.shields.io/packagist/dt/clue/ssdp-react?color=blue&label=installs%20on%20Packagist)](https://packagist.org/packages/clue/ssdp-react) -Async [Simple Service Discovery Protocol (SSDP)](http://en.wikipedia.org/wiki/Simple_Service_Discovery_Protocol), built on top of [ReactPHP](https://reactphp.org/). +Async [Simple Service Discovery Protocol (SSDP)](https://en.wikipedia.org/wiki/Simple_Service_Discovery_Protocol), built on top of [ReactPHP](https://reactphp.org/). -SSDP is part of [Universal Plug and Play (UPnP)](http://de.wikipedia.org/wiki/Universal_Plug_and_Play) +SSDP is part of [Universal Plug and Play (UPnP)](https://de.wikipedia.org/wiki/Universal_Plug_and_Play) and is commonly used to discover network services on home networks without requiring any manual configuration, such as automatically discovering printers, multimedia devices and network routers. @@ -15,7 +15,7 @@ This library implements SSDP as defined in the and uses HTTP over Multicast UDP (HTTPMU) as defined in the [IETF draft](https://tools.ietf.org/html/draft-goland-http-udp-01). As an alternative, some devices use DNS-Based Service Discovery (DNS-SD) instead -as defined in [RFC 6763](http://tools.ietf.org/html/rfc6763). +as defined in [RFC 6763](https://tools.ietf.org/html/rfc6763). **Table of Contents** @@ -48,11 +48,11 @@ $client->search()->then( ); ``` -See also the [examples](examples). +See also the [examples](examples/). ## 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) ```JSON { @@ -65,21 +65,21 @@ The recommended way to install this library is [through composer](http://getcomp 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. -It's *highly recommended to use PHP 7+* for this project. +It's *highly recommended to use the latest supported PHP version* for this project. ## Tests To run the test suite, you first need to clone this repo and then install all -dependencies [through Composer](https://getcomposer.org): +dependencies [through Composer](https://getcomposer.org/): ```bash -$ composer install +composer install ``` To run the test suite, go to the project root and run: ```bash -$ php vendor/bin/phpunit +php vendor/bin/phpunit ``` ## License