|
1 | | -# Yokai Batch |
| 1 | +# symfony/serializer bridge for Batch processing library |
2 | 2 |
|
3 | 3 | [](https://packagist.org/packages/yokai/batch-symfony-serializer) |
4 | 4 | [](https://packagist.org/packages/yokai/batch-symfony-serializer) |
5 | 5 |
|
6 | | -Bridge of [`symfony/serializer`](https://github.com/symfony/serializer) for [Batch](https://github.com/yokai-php/batch-src). |
| 6 | +Bridge of [`symfony/serializer`](https://github.com/symfony/serializer) for [Batch](https://github.com/yokai-php/batch). |
| 7 | + |
| 8 | + |
| 9 | +## :warning: BETA |
| 10 | + |
| 11 | +This library is following [semver](https://semver.org/). |
| 12 | +However before we reach the first stable version (`v1.0.0`), we may decide to introduce **API changes in minor versions**. |
| 13 | +This is why you should stick to a `v0.[minor].*` requirement ! |
| 14 | + |
| 15 | + |
| 16 | +# Installation |
| 17 | + |
| 18 | +``` |
| 19 | +composer require yokai/batch-symfony-serializer |
| 20 | +``` |
7 | 21 |
|
8 | 22 |
|
9 | 23 | ## Documentation |
10 | 24 |
|
11 | | -Please refer to [main repository](https://github.com/yokai-php/batch-src) documentation. |
| 25 | +This package provides: |
| 26 | + |
| 27 | +- an [item processor](docs/normalize-item-processor.md) that uses normalization |
| 28 | +- an [item processor](docs/denormalize-item-processor.md) that uses denormalization |
| 29 | +- a [job execution serializer](docs/job-execution-serializer.md) that uses serialization |
12 | 30 |
|
13 | 31 |
|
14 | 32 | ## Contribution |
15 | 33 |
|
| 34 | +This package is a readonly split of a [larger repository](https://github.com/yokai-php/batch-src), |
| 35 | +containing all tests and sources for all librairies of the batch universe. |
| 36 | + |
16 | 37 | Please feel free to open an [issue](https://github.com/yokai-php/batch-src/issues) |
17 | 38 | or a [pull request](https://github.com/yokai-php/batch-src/pulls) |
18 | 39 | in the [main repository](https://github.com/yokai-php/batch-src). |
19 | 40 |
|
| 41 | +The library was originally created by [Yann Eugoné](https://github.com/yann-eugone). |
| 42 | +See the list of [contributors](https://github.com/yokai-php/batch-src/contributors). |
| 43 | + |
20 | 44 |
|
21 | | -## MIT License |
| 45 | +## License |
22 | 46 |
|
23 | | -License can be found [here](LICENSE). |
| 47 | +This library is under MIT [LICENSE](LICENSE). |
0 commit comments