@@ -23,23 +23,34 @@ its event-driven model to react to changes and events happening.
23
23
and does not get in your way.
24
24
This library is merely a very thin wrapper around the [ Docker Engine API] ( https://docs.docker.com/develop/sdk/ ) .
25
25
* ** Good test coverage** -
26
- Comes with an automated tests suite and is regularly tested in the * real world*
26
+ Comes with an automated tests suite and is regularly tested in the * real world* .
27
27
28
28
** Table of contents**
29
29
30
+ * [ Support us] ( #support-us )
30
31
* [ Quickstart example] ( #quickstart-example )
31
32
* [ Usage] ( #usage )
32
- * [ Client] ( #client )
33
- * [ Commands] ( #commands )
34
- * [ Promises] ( #promises )
35
- * [ Blocking] ( #blocking )
36
- * [ Command streaming] ( #command-streaming )
37
- * [ TAR streaming] ( #tar-streaming )
38
- * [ JSON streaming] ( #json-streaming )
33
+ * [ Client] ( #client )
34
+ * [ Commands] ( #commands )
35
+ * [ Promises] ( #promises )
36
+ * [ Blocking] ( #blocking )
37
+ * [ Command streaming] ( #command-streaming )
38
+ * [ TAR streaming] ( #tar-streaming )
39
+ * [ JSON streaming] ( #json-streaming )
39
40
* [ Install] ( #install )
40
41
* [ Tests] ( #tests )
41
42
* [ License] ( #license )
42
43
44
+ ## Support us
45
+
46
+ We invest a lot of time developing, maintaining and updating our awesome
47
+ open-source projects. You can help us sustain this high-quality of our work by
48
+ [ becoming a sponsor on GitHub] ( https://github.com/sponsors/clue ) . Sponsors get
49
+ numerous benefits in return, see our [ sponsoring page] ( https://github.com/sponsors/clue )
50
+ for details.
51
+
52
+ Let's take these projects to the next level together! 🚀
53
+
43
54
## Quickstart example
44
55
45
56
Once [ installed] ( #install ) , you can use the following code to access the
@@ -354,24 +365,26 @@ See also the [pull example](examples/pull.php) and the [push example](examples/p
354
365
355
366
## Install
356
367
357
- The recommended way to install this library is [ through Composer] ( https://getcomposer.org ) .
358
- [ New to composer ?] ( https://getcomposer.org/doc/00-intro.md )
368
+ The recommended way to install this library is [ through Composer] ( https://getcomposer.org/ ) .
369
+ [ New to Composer ?] ( https://getcomposer.org/doc/00-intro.md )
359
370
360
371
This project follows [ SemVer] ( https://semver.org/ ) .
361
372
This will install the latest supported version:
362
373
363
374
``` bash
364
- $ composer require clue/docker-react:^1.2
375
+ $ composer require clue/docker-react:^1.3
365
376
```
366
377
378
+ See also the [ CHANGELOG] ( CHANGELOG.md ) for details about version upgrades.
379
+
367
380
This project aims to run on any platform and thus does not require any PHP
368
381
extensions and supports running on legacy PHP 5.3 through current PHP 8+.
369
382
It's * highly recommended to use PHP 7+* for this project.
370
383
371
384
## Tests
372
385
373
386
To run the test suite, you first need to clone this repo and then install all
374
- dependencies [ through Composer] ( https://getcomposer.org ) :
387
+ dependencies [ through Composer] ( https://getcomposer.org/ ) :
375
388
376
389
``` bash
377
390
$ composer install
0 commit comments