Skip to content

Commit 2b96e25

Browse files
authored
Add missing documentation to README.md
Update `README.md` to reflect the latest changes in dependencies and testing.
1 parent 90c9065 commit 2b96e25

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ compliant requests that can be used as well as high level abstractions to ease d
3333

3434
| Dependency | Version | Reason |
3535
|:--- |:---:|:--- |
36-
| **`php`** | ~7.0 | Anything lower has reached EOL |
36+
| **`php`** | ~7.1 | Anything lower has reached EOL |
3737
| **`guzzlephp/guzzle`** | ~6.3 | Using `Request` to build PSR-7 `RequestInterface` |
3838
| **`beberlei/assert`** | ~2.7 | The de-facto standard assertions library for PHP |
39-
| **`flix-tech/avro-php`** | ^2.0 | Maintained fork of the only Avro PHP implementation: `rg/avro-php` |
39+
| **`wikimedia/avro`** | dev-master | TEMPORARY: Critical bug fixes require dev-master until new release is tagged |
4040

4141
### Optional dependencies
4242

@@ -50,9 +50,14 @@ compliant requests that can be used as well as high level abstractions to ease d
5050
This library is installed via [`composer`](http://getcomposer.org).
5151

5252
```bash
53-
composer require "flix-tech/confluent-schema-registry-api=~4.0"
53+
composer require "flix-tech/confluent-schema-registry-api=^5.1"
5454
```
5555

56+
> **NOTE**
57+
>
58+
> If you are still running on a version less than `5.0.3` we recommend updating it immediately since there was a critical
59+
> bug with the exception handling.
60+
5661
## Compatibility
5762

5863
This library follows strict semantic versioning, so you can expect any minor and patch release to be compatible, while
@@ -235,22 +240,34 @@ You can set the default variables by copying `variables.mk.dist` to `variables.m
235240
#### Build the local docker image
236241

237242
```bash
238-
make docker
243+
PHP_VERSION=7.1 XDEBUG_VERSION=2.6.1 make docker
239244
```
240245

241246
#### Unit tests, Coding standards and static analysis
242247

243248
```bash
244-
make ci-local
249+
PHP_VERSION=7.1 make ci-local
245250
```
246251

247252
#### Integration tests
248253

249254
This library uses a `docker-compose` configuration to fire up a schema registry for integration testing, hence
250255
`docker-compose` from version 1.13.0 is required to run those tests.
251256

257+
##### The platform can be controlled with the following environment variables
258+
259+
```
260+
CONFLUENT_VERSION=latest
261+
CONFLUENT_NETWORK_SUBNET=172.68.0.0/24
262+
SCHEMA_REGISTRY_IPV4=172.68.0.103
263+
KAFKA_BROKER_IPV4=172.68.0.102
264+
ZOOKEEPER_IPV4=172.68.0.101
265+
```
266+
267+
##### Building the confluent platform with a specific version and run the integation tests
268+
252269
```bash
253-
CONFLUENT_VERSION=5.0.0 make platform
270+
CONFLUENT_VERSION=5.0.3 make platform
254271
make phpunit-integration
255272
make clean
256273
```

0 commit comments

Comments
 (0)