Skip to content

Commit 1f9060a

Browse files
committed
Prepare v1.3.0 release
1 parent ed33e13 commit 1f9060a

File tree

2 files changed

+30
-11
lines changed

2 files changed

+30
-11
lines changed

CHANGELOG.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
1-
# CHANGELOG
1+
# Changelog
22

3-
This file is a manually maintained list of changes for each release. Feel free
4-
to add your changes here when sending pull requests. Also send corrections if
5-
you spot any mistakes.
3+
## 1.3.0 (2018-06-10)
4+
5+
* Feature: Add `$timeout` parameter for `Factory::createClient()`
6+
(#39 by @Elbandi and @clue)
7+
8+
```php
9+
// connect to Google, but wait no longer than 2.5s for connection
10+
$socket = $factory->createClient('www.google.com:80', 2.5);
11+
```
12+
13+
* Improve test suite by adding PHPUnit to require-dev,
14+
update test suite to test against legacy PHP 5.3 through PHP 7.2 and
15+
optionally skip functional integration tests requiring internet.
16+
(#26 by @ascii-soup, #28, #29, #37 and #38 by @clue)
617

718
## 1.2.0 (2015-03-18)
819

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This lightweight library exposes this socket API in a modern way by providing a
1414
Uses a fluent interface so you can easily chain method calls.
1515
Error conditions will be signalled using `Exception`s instead of relying on cumbersome return codes.
1616
* **Lightweight, SOLID design** -
17-
Provides a thin abstraction that is [*just good enough*](http://en.wikipedia.org/wiki/Principle_of_good_enough)
17+
Provides a thin abstraction that is [*just good enough*](https://en.wikipedia.org/wiki/Principle_of_good_enough)
1818
and does not get in your way.
1919
This library is merely a very thin wrapper and has no other external dependencies.
2020
* **Good test coverage** -
@@ -108,7 +108,7 @@ $socket = $factory->createClient('icmp://192.168.0.1');
108108

109109
The `createServer($address)` method can be used to create a server side (listening) socket bound to specific address/path
110110
(similar to how [`stream_socket_server()`](http://www.php.net/manual/en/function.stream-socket-server.php) works).
111-
It accepts the same addressing scheme as the [`createClient()`](#createClient) method.
111+
It accepts the same addressing scheme as the [`createClient()`](#createclient) method.
112112

113113
```php
114114
// create a TCP/IP stream connection socket server on port 1337
@@ -188,15 +188,20 @@ $socket->close();
188188

189189
## Install
190190

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

194194
```bash
195-
$ composer require clue/socket-raw:~1.2
195+
$ composer require clue/socket-raw:^1.3
196196
```
197197

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

200+
This project aims to run on any platform and thus does not require any PHP
201+
extensions besides `ext-sockets` and supports running on legacy PHP 5.3 through
202+
current PHP 7+ and HHVM.
203+
It's *highly recommended to use PHP 7+* for this project.
204+
200205
## Tests
201206

202207
To run the test suite, you first need to clone this repo and then install all
@@ -216,7 +221,7 @@ Note that the test suite contains tests for ICMP sockets which require root
216221
access on Unix/Linux systems. Therefor some tests will be skipped unless you run
217222
the following command to execute the full test suite:
218223

219-
```php
224+
```bash
220225
$ sudo php vendor/bin/phpunit
221226
```
222227

@@ -230,4 +235,7 @@ $ php vendor/bin/phpunit --exclude-group internet
230235

231236
## License
232237

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

0 commit comments

Comments
 (0)