Skip to content

Commit

Permalink
Prepare v1.3.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
clue committed Dec 17, 2020
1 parent 62dc397 commit c61783a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 12 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Changelog

# 1.3.0 (2020-12-17)

* Feature: Update to reactphp/http v1.0.0.
(#64 by @clue)

* Improve test suite and add `.gitattributes` to exclude dev files from exports.
Add PHP 8 support, update to PHPUnit 9 and simplify test setup.
(#62, #65, #66 and #67 by @SimonFrings)

## 1.2.0 (2020-03-31)

* Feature: Add `containerAttach()` and `containerAttachStream()` API methods.
Expand Down
37 changes: 25 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,34 @@ its event-driven model to react to changes and events happening.
and does not get in your way.
This library is merely a very thin wrapper around the [Docker Engine API](https://docs.docker.com/develop/sdk/).
* **Good test coverage** -
Comes with an automated tests suite and is regularly tested in the *real world*
Comes with an automated tests suite and is regularly tested in the *real world*.

**Table of contents**

* [Support us](#support-us)
* [Quickstart example](#quickstart-example)
* [Usage](#usage)
* [Client](#client)
* [Commands](#commands)
* [Promises](#promises)
* [Blocking](#blocking)
* [Command streaming](#command-streaming)
* [TAR streaming](#tar-streaming)
* [JSON streaming](#json-streaming)
* [Client](#client)
* [Commands](#commands)
* [Promises](#promises)
* [Blocking](#blocking)
* [Command streaming](#command-streaming)
* [TAR streaming](#tar-streaming)
* [JSON streaming](#json-streaming)
* [Install](#install)
* [Tests](#tests)
* [License](#license)

## Support us

We invest a lot of time developing, maintaining and updating our awesome
open-source projects. You can help us sustain this high-quality of our work by
[becoming a sponsor on GitHub](https://github.com/sponsors/clue). Sponsors get
numerous benefits in return, see our [sponsoring page](https://github.com/sponsors/clue)
for details.

Let's take these projects to the next level together! 🚀

## Quickstart example

Once [installed](#install), you can use the following code to access the
Expand Down Expand Up @@ -354,24 +365,26 @@ See also the [pull example](examples/pull.php) and the [push example](examples/p

## Install

The recommended way to install this library is [through Composer](https://getcomposer.org).
[New to composer?](https://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)

This project follows [SemVer](https://semver.org/).
This will install the latest supported version:

```bash
$ composer require clue/docker-react:^1.2
$ composer require clue/docker-react:^1.3
```

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

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+.
It's *highly recommended to use PHP 7+* 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
Expand Down

0 comments on commit c61783a

Please sign in to comment.