Skip to content

Commit

Permalink
add upgrade instructions
Browse files Browse the repository at this point in the history
Release 1.1.0 introduced a BC break in the `CloudInterface`. This
commit adds a warning and additional upgrade instructions for users
implementing this interface.
  • Loading branch information
xabbuh committed Oct 24, 2014
1 parent 90bd071 commit b75805f
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

1.1.1
-----

* update installation instructions regarding the BC break introduced in 1.1.0

1.1.0
-----

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ PandaClient
The PandaClient package provides an easy to use implementation of the
[Panda encoding services](https://www.pandastream.com/) REST API.

**Caution:** Version 1.1.0 introduced a BC break for users implementing the
`CloudInterface`. Read the [upgrade instructions](UPGRADE-1.1.md) for more
information.

Installation
------------

Expand Down
41 changes: 41 additions & 0 deletions UPGRADE-1.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Upgrade from 1.0 to 1.1
=======================

The `encodeVideoByUrl()` and `encodeVideoFile()` method got additional parameters.
If you implement this interface, you'll have to reflect these changes.

Before:

```php
// ...

public function encodeVideoByUrl($url)
{
// ...
}

public function encodeVideoFile($localPath)
{
// ...
}

// ...
```

After:

```php
// ...

public function encodeVideoByUrl($url, array $profiles = array(), $pathFormat = null, $payload = null)
{
// ...
}

public function encodeVideoFile($localPath, array $profiles = array(), $pathFormat = null, $payload = null)
{
// ...
}

// ...
```

0 comments on commit b75805f

Please sign in to comment.