v1 -> v2 migration guide start

This commit is contained in:
Biarity 2018-04-20 19:06:40 +10:00 committed by GitHub
parent 678f1d1daa
commit 3350ff5c19
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -179,5 +179,16 @@ It is recommended that you write exception-handling middleware to globally handl
### Example project
You can find an example project incorporating most Sieve concepts in [SieveTests](https://github.com/Biarity/Sieve/tree/master/SieveTests).
## Upgrading from v1.* to v2.*
* Changes to the `SieveProcessor` API:
* `ApplyAll` is now `Apply`
* `ApplyFiltering`, `ApplySorting`, and `ApplyPagination` are now depricated - instead you can use optional arguments on `Apply` to achieve the same
* Instead of just removing commas from `{Value}`s, [you'll also need to remove brackets and pipes](#send-a-request)
## License & Contributing
Sieve is licensed under Apache 2.0. Any contributions highly appreciated!