Skip to content

Commit bbb7145

Browse files
committed
Improve documentation and fix typo
1 parent ef827a6 commit bbb7145

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# clue/reactphp-mdns
22

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

66
Simple, async multicast DNS (mDNS) resolver for zeroconf networking, built on top of [ReactPHP](https://reactphp.org/).
77

88
[Multicast DNS](http://www.multicastdns.org/) name resolution is commonly used
9-
as part of [zeroconf networking](http://en.wikipedia.org/wiki/Zero-configuration_networking).
9+
as part of [zeroconf networking](https://en.wikipedia.org/wiki/Zero-configuration_networking).
1010
It is used by Mac OS X (Bonjour), many Linux distributions (Avahi) and quite a few other networking devices such as printers, camers etc. to resolve hostnames of your local LAN clients to IP addresses.
1111

12-
This library implements the mDNS protocol as defined in [RFC 6762](http://tools.ietf.org/html/rfc6762).
12+
This library implements the mDNS protocol as defined in [RFC 6762](https://tools.ietf.org/html/rfc6762).
1313
Note that this protocol is related to, but independent of, DNS-Based Service Discovery (DNS-SD)
14-
as defined in [RFC 6763](http://tools.ietf.org/html/rfc6763).
14+
as defined in [RFC 6763](https://tools.ietf.org/html/rfc6763).
1515

1616
**Table of Contents**
1717

@@ -88,7 +88,7 @@ $resolver->lookup($hostname)->then(
8888
// IP successfully resolved
8989
},
9090
function (Exception $e) {
91-
// an error occured while looking up the given hostname
91+
// an error occurred while looking up the given hostname
9292
}
9393
});
9494
```
@@ -116,7 +116,7 @@ try {
116116
$ip = Block\await($promise, $loop);
117117
// IP successfully resolved
118118
} catch (Exception $e) {
119-
// an error occured while performing the request
119+
// an error occurred while performing the request
120120
}
121121
```
122122

@@ -135,43 +135,46 @@ Please refer to [clue/reactphp-block](https://github.com/clue/reactphp-block#rea
135135

136136
## Install
137137

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

141141
```bash
142-
$ composer require clue/mdns-react:~0.2.0
142+
composer require clue/mdns-react:~0.2.0
143143
```
144144

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

147147
This project aims to run on any platform and thus does not require any PHP
148148
extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
149149
HHVM.
150-
It's *highly recommended to use PHP 7+* for this project.
150+
It's *highly recommended to use the latest supported PHP version* for this project.
151151

152152
## Tests
153153

154154
To run the test suite, you first need to clone this repo and then install all
155-
dependencies [through Composer](https://getcomposer.org):
155+
dependencies [through Composer](https://getcomposer.org/):
156156

157157
```bash
158-
$ composer install
158+
composer install
159159
```
160160

161161
To run the test suite, go to the project root and run:
162162

163163
```bash
164-
$ php vendor/bin/phpunit
164+
vendor/bin/phpunit
165165
```
166166

167167
## License
168168

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

171174
## More
172175

173-
* Multicast DNS is defined in [RFC 6762](http://tools.ietf.org/html/rfc6762), in particular
176+
* Multicast DNS is defined in [RFC 6762](https://tools.ietf.org/html/rfc6762), in particular
174177
this specification also highlights the
175-
[differences to normal DNS operation](http://tools.ietf.org/html/rfc6762#section-19).
178+
[differences to normal DNS operation](https://tools.ietf.org/html/rfc6762#section-19).
176179
* Please refer to the [react/dns component](https://github.com/reactphp/dns#readme) for more details
177180
about normal DNS operation.

0 commit comments

Comments
 (0)