Skip to content

Commit 950e4ba

Browse files
committed
Rewrite packages README after monorepo split
1 parent 5e17319 commit 950e4ba

File tree

4 files changed

+32
-5
lines changed

4 files changed

+32
-5
lines changed

README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,47 @@
1-
# Yokai Batch
1+
# symfony/serializer bridge for Batch processing library
22

33
[![Latest Stable Version](https://img.shields.io/packagist/v/yokai/batch-symfony-serializer?style=flat-square)](https://packagist.org/packages/yokai/batch-symfony-serializer)
44
[![Downloads Monthly](https://img.shields.io/packagist/dm/yokai/batch-symfony-serializer?style=flat-square)](https://packagist.org/packages/yokai/batch-symfony-serializer)
55

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+
```
721

822

923
## Documentation
1024

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
1230

1331

1432
## Contribution
1533

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+
1637
Please feel free to open an [issue](https://github.com/yokai-php/batch-src/issues)
1738
or a [pull request](https://github.com/yokai-php/batch-src/pulls)
1839
in the [main repository](https://github.com/yokai-php/batch-src).
1940

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+
2044

21-
## MIT License
45+
## License
2246

23-
License can be found [here](LICENSE).
47+
This library is under MIT [LICENSE](LICENSE).

docs/denormalize-item-processor.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
todo

docs/job-execution-serializer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
todo

docs/normalize-item-processor.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
todo

0 commit comments

Comments
 (0)