README.md
1# jms/serializer
2
3| [Master][Master] | [1.x][1.x] |
4|:----------------:|:----------:|
5| [![Build status][Master image]][Master] | [![Build status][1.x image]][1.x] |
6| [![Coverage Status][Master coverage image]][Master coverage] | [![Coverage Status][1.x coverage image]][1.x coverage] |
7
8
9
10## Introduction
11
12This library allows you to (de-)serialize data of any complexity. Currently, it supports XML and JSON.
13
14It also provides you with a rich tool-set to adapt the output to your specific needs.
15
16Built-in features include:
17
18- (De-)serialize data of any complexity; circular references and complex exclusion strategies are handled gracefully.
19- Supports many built-in PHP types (such as dates, intervals)
20- Integrates with Doctrine ORM, et. al.
21- Supports versioning, e.g. for APIs
22- Configurable via XML, YAML, or Annotations
23
24
25## Documentation
26
27Learn more about the serializer in its [documentation](http://jmsyst.com/libs/serializer).
28
29## Notes
30
31You are browsing the code for the 2.x version, if you are interested in the 1.x version,
32check the [1.x][1.x] branch.
33
34Differences between the 1.x and 2.x can be found in the [CHANGELOG][CHANGELOG].
35Upgrading from 1.x to 2.x should be almost transparent for most of the userland code, in the
36case you have heavily used internal-api or you are relaying on some of the removed features,
37the [UPGRADING][UPGRADING] document is a short guide on how to upgrade.
38
39Pull requests for new features are accepted only on the master branch.
40Bug fixes are accepted for both master and 1.x branches.
41Bug fixes sent on the 1.x branch, will be ported to the master branch when possible.
42
43 [CHANGELOG]: https://github.com/schmittjoh/serializer/blob/master/CHANGELOG.md
44 [UPGRADING]: https://github.com/schmittjoh/serializer/blob/master/UPGRADING.md
45
46 [Master image]: https://img.shields.io/travis/schmittjoh/serializer/master.svg?style=flat-square
47 [Master]: https://travis-ci.org/schmittjoh/serializer
48 [Master coverage image]: https://img.shields.io/scrutinizer/coverage/g/schmittjoh/serializer/master.svg?style=flat-square
49 [Master coverage]: https://scrutinizer-ci.com/g/schmittjoh/serializer/?branch=master
50
51 [1.x image]: https://img.shields.io/travis/schmittjoh/serializer/1.x.svg?style=flat-square
52 [1.x]: https://github.com/schmittjoh/serializer/tree/1.x
53 [1.x coverage image]: https://img.shields.io/scrutinizer/coverage/g/schmittjoh/serializer/1.x.svg?style=flat-square
54 [1.x coverage]: https://scrutinizer-ci.com/g/schmittjoh/serializer/?branch=1.x
55
56
