Skip to content

Commit 9718e6a

Browse files
authored
Merge pull request #47 from clue-labs/name
Update project homepage
2 parents 41d92f6 + 6b2228d commit 9718e6a

3 files changed

Lines changed: 79 additions & 74 deletions

File tree

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
1-
# clue/docker-react [![Build Status](https://travis-ci.org/clue/php-docker-react.svg?branch=master)](https://travis-ci.org/clue/php-docker-react)
1+
# clue/reactphp-docker [![Build Status](https://travis-ci.org/clue/reactphp-docker.svg?branch=master)](https://travis-ci.org/clue/reactphp-docker)
22

3-
Simple async/streaming access to the [Docker](https://www.docker.com/) API, built on top of [React PHP](http://reactphp.org/).
3+
Async, event-driven access to the [Docker Engine API](https://docs.docker.com/develop/sdk/), built on top of [ReactPHP](https://reactphp.org/).
44

55
[Docker](https://www.docker.com/) is a popular open source platform
66
to run and share applications within isolated, lightweight containers.
7-
The [Docker Remote API](https://docs.docker.com/reference/api/docker_remote_api_v1.15/)
7+
The [Docker Engine API](https://docs.docker.com/develop/sdk/)
88
allows you to control and monitor your containers and images.
99
Among others, it can be used to list existing images, download new images,
1010
execute arbitrary commands within isolated containers, stop running containers and much more.
11+
This lightweight library provides an efficient way to work with the Docker Engine API
12+
from within PHP. It enables you to work with its images and containers or use
13+
its event-driven model to react to changes and events happening.
1114

1215
* **Async execution of Actions** -
1316
Send any number of actions (commands) to your Docker daemon in parallel and
1417
process their responses as soon as results come in.
15-
The Promise-based design provides a *sane* interface to working with out of bound responses.
18+
The Promise-based design provides a *sane* interface to working with out of order responses.
1619
* **Lightweight, SOLID design** -
17-
Provides a thin abstraction that is [*just good enough*](http://en.wikipedia.org/wiki/Principle_of_good_enough)
20+
Provides a thin abstraction that is [*just good enough*](https://en.wikipedia.org/wiki/Principle_of_good_enough)
1821
and does not get in your way.
19-
This library is merely a very thin wrapper around the Remote API.
22+
This library is merely a very thin wrapper around the [Docker Engine API](https://docs.docker.com/develop/sdk/).
2023
* **Good test coverage** -
2124
Comes with an automated tests suite and is regularly tested in the *real world*
2225

@@ -100,7 +103,7 @@ The recommended way to create a `Client` is using the `Factory` (see above).
100103

101104
#### Commands
102105

103-
All public methods on the `Client` resemble the API described in the [Remote API documentation](https://docs.docker.com/reference/api/docker_remote_api_v1.15/) like this:
106+
All public methods on the `Client` resemble the API described in the [Docker Engine API documentation](https://docs.docker.com/develop/sdk/) like this:
104107

105108
```php
106109
$client->containerList($all, $size);
@@ -120,7 +123,7 @@ $client->version();
120123
```
121124

122125
Listing all available commands is out of scope here, please refer to the
123-
[Remote API documentation](https://docs.docker.com/reference/api/docker_remote_api_v1.15/)
126+
[Docker Engine API documentation](https://docs.docker.com/develop/sdk/)
124127
or the [class outline](src/Client.php).
125128

126129
Each of these commands supports async operation and either *resolves* with its *results*
@@ -151,7 +154,7 @@ If this looks strange to you, you can also use the more traditional [blocking AP
151154
As stated above, this library provides you a powerful, async API by default.
152155

153156
If, however, you want to integrate this into your traditional, blocking environment,
154-
you should look into also using [clue/block-react](https://github.com/clue/php-block-react).
157+
you should look into also using [clue/reactphp-block](https://github.com/clue/reactphp-block).
155158

156159
The resulting blocking code could look something like this:
157160

@@ -183,7 +186,7 @@ $promises = array(
183186
$inspections = Block\awaitAll($promises, $loop);
184187
```
185188

186-
Please refer to [clue/block-react](https://github.com/clue/php-block-react#readme) for more details.
189+
Please refer to [clue/reactphp-block](https://github.com/clue/reactphp-block#readme) for more details.
187190

188191
#### Command streaming
189192

@@ -279,7 +282,7 @@ $stream = $client->containerCopyStream($image, $config);
279282

280283
Accessing individual files in the TAR file format string or stream is out of scope
281284
for this library.
282-
Several libraries are available, one that is known to work is [clue/tar-react](https://github.com/clue/php-tar-react).
285+
Several libraries are available, one that is known to work is [clue/reactphp-tar](https://github.com/clue/reactphp-tar).
283286

284287
See also the [copy example](examples/copy.php) and the [export example](examples/export.php).
285288

@@ -380,7 +383,8 @@ The `getData()` method can be used to obtain the progress message.
380383

381384
## Install
382385

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

385389
```JSON
386390
{

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "clue/docker-react",
3-
"description": "Simple async/streaming Docker client",
3+
"description": "Async, event-driven access to the Docker Engine API, built on top of ReactPHP.",
44
"keywords": ["Docker", "container", "ReactPHP", "async"],
5-
"homepage": "https://github.com/clue/php-docker-react",
5+
"homepage": "https://github.com/clue/reactphp-docker",
66
"license": "MIT",
77
"authors": [
88
{

0 commit comments

Comments
 (0)