Skip to content
This repository has been archived by the owner on Nov 16, 2022. It is now read-only.

Commit

Permalink
Updated the docs to reflect new changes, and help users upgrading
Browse files Browse the repository at this point in the history
  • Loading branch information
davidyell committed Oct 6, 2015
1 parent 2e64fd8 commit db071cd
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ All the documentation can be found in the [docs](docs) folder.
* [Shell tasks](docs/shell.md)
* [Examples](docs/examples.md)
* [FAQ](docs/faq.md)

**NB** Please be aware of the change of configuration between versions `0.4.2` and `0.5.0`.
[See the FAQ](/docs/faq.md#bootstrap-file-is-missing).
* [Upgrading](docs/upgrading.md)

##Contribution
Please open a pull request or submit an issue if there is anything you would like to contribute. Please write a test for
Expand Down
35 changes: 35 additions & 0 deletions docs/upgrading.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Upgrading
If you are upgrading between versions this documentation page will give you some insights into the changes which you
will need to make and potential pitfalls.

For more release information [please see the releases](https://github.com/davidyell/CakePHP3-Proffer/releases).

## 0.6.0
[Release 0.6.0](https://github.com/davidyell/CakePHP3-Proffer/releases/tag/0.6.0)

When migrating to `0.6.0` you might encounter problems with validation, specifically the `filesize()` method. You will
need to change the param order to match, `fileSize($check, $operator = null, $size = null)`. This is documented in the
[api validation docs](http://api.cakephp.org/3.0/class-Cake.Validation.Validation.html#_fileSize).

The `operator` can be either a word or operand is greater >, is less <, greater or equal >= less or equal <=, is less <,
equal to ==, not equal !=.

## 0.5.0
[Release 0.5.0](https://github.com/davidyell/CakePHP3-Proffer/tree/0.5.0)

When upgrading to `0.5.0` you no longer need to bootstrap the plugin, as the data type class will be loaded
automatically.

So the only change required is to change your `config/bootstrap.php` to be `Plugin::load('Proffer')`.

## 0.4.0
[Release 0.4.0](https://github.com/davidyell/CakePHP3-Proffer/releases/tag/v0.4.0)

This version removes some of the events in the plugin, so any code which hooks the events will need to be updated.
Instead of hooking these events you can inject your own transform class in the plugin in which you can implement your
changes.

## 0.3.0
[Release 0.3.0](https://github.com/davidyell/CakePHP3-Proffer/releases/tag/v0.3.0)

If you need to make the generation of thumbnails optional, this is now possible by updating the configuration.

0 comments on commit db071cd

Please sign in to comment.