Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tomglvng authored Jan 25, 2022
1 parent c43fdd4 commit 251fbbc
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ Matrix compatibility:
| v2.3 | v3.0 | [![Build Status](https://travis-ci.org/akeneo/api-php-client.svg?branch=3.0)](https://travis-ci.org/akeneo/api-php-client) |
| v3.0 - v4.0 | v4.0 - v5.0 | [![Build Status](https://travis-ci.org/akeneo/api-php-client.svg?branch=4.0)](https://travis-ci.org/akeneo/api-php-client) |
| v5.0 | v6.0 | - |
| v6.0 | v7.0 | - |
| - | master | [![CircleCI](https://circleci.com/gh/akeneo/api-php-client/tree/master.svg?style=svg)](https://circleci.com/gh/akeneo/api-php-client/tree/master) |

Note that our PHP client is backward compatible.
For example, if your PIM is currently a v2.3, you can still use a 1.0 version of the PHP client. The new endpoints available in v2.3 will not be available in the v1.0 of the PHP client.

## Requirements

* PHP >= 7.1
* PHP >= 7.4
* Composer

## Installation
Expand Down Expand Up @@ -147,19 +148,20 @@ $client->getProductApi()->upsertList([
Do note that you have to delete the `composer.lock` because Doctrine dependencies are loaded.
These dependencies are different in function of the PHP version running `composer install`.

```
cp docker-compose.yml.dist docker-compose.yml
rm -rf composer.lock vendor/
docker-compose run client_72 composer install
docker-compose run client_72 bin/phpunit -c phpunit.xml.dist
docker-compose run client_72 bin/phpspec run
docker-compose run client_72 bin/php-cs-fixer fix --diff --dry-run --config=.php_cs.php -vvv
```
``` bash
# Build the project
make dependencies

Or use `make`:
# Run PHPUnit tests
make unit

```
make dependencies
# Run PHPSpec tests
make spec

# Run code style check
make cs

# ... or directly run all tests
make tests
```

Expand Down

0 comments on commit 251fbbc

Please sign in to comment.