Skip to content

Commit 5dba277

Browse files
committed
Backport README update to 2.12 branch
1 parent a9dbcc3 commit 5dba277

File tree

1 file changed

+68
-12
lines changed

1 file changed

+68
-12
lines changed

README.md

Lines changed: 68 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,81 @@
1-
## Overview
1+
# Overview
22

33
This is a multi-module umbrella project for [Jackson](../../../jackson)
44
standard binary dataformat backends.
55

6-
Currently included are:
6+
Dataformat backends are used to support format alternatives to JSON, using
7+
general-purpose Jackson API. Formats included allow access using all 3
8+
API styles (streaming, databinding, tree model).
79

8-
* [Avro](avro/)
9-
* [CBOR](cbor/)
10-
* [Ion](ion/)
11-
* [Protobuf](protobuf/)
12-
* [Smile](smile/)
10+
For Jackson 2.x this is done by sub-classing Jackson core abstractions of:
1311

14-
## License
12+
* All backends sub-class `JsonFactory`, which is factory for:
13+
* `JsonParser` for reading data (decoding data encoding in supported format)
14+
* `JsonGenerator` for writing data (encoding data using supported format)
15+
* Starting with 2.10 there is also sub-class of `ObjectMapper` (like `CBORMapper`, `SmileMapper`) for all formats, mostly for convenience
16+
* Jackson 2.10 also added "Builder" style construction for above-mentioned factories, mappers.
17+
18+
# Status
19+
20+
[![Build Status](https://travis-ci.org/FasterXML/jackson-dataformats-binary.svg)](https://travis-ci.org/FasterXML/jackson-dataformats-binary)
21+
22+
# Binary formats supported
23+
24+
Currently included backends are:
25+
26+
* [Avro](avro/) ([Avro format](http://avro.apache.org/docs/current))
27+
* [CBOR](cbor/) ([CBOR format](https://tools.ietf.org/html/rfc7049))
28+
* [Ion](ion/) ([Ion format](https://amznlabs.github.io/ion-docs/))
29+
* [Protobuf](protobuf/) ([Protobuf format](https://developers.google.com/protocol-buffers/))
30+
* [Smile](smile/) ([Smile format](https://github.com/FasterXML/smile-format-specification))
31+
32+
# License
1533

1634
All modules are licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt).
1735

18-
## Status
36+
# Maven dependencies
1937

20-
[![Build Status](https://travis-ci.org/FasterXML/jackson-dataformats-binary.svg)](https://travis-ci.org/FasterXML/jackson-dataformats-binary)
38+
To use these format backends Maven-based projects, use following dependency:
39+
40+
```xml
41+
<dependency>
42+
<groupId>com.fasterxml.jackson.dataformat</groupId>
43+
<artifactId>jackson-dataformat-[FORMAT]</artifactId>
44+
<version>2.12.2</version>
45+
</dependency>
46+
```
47+
48+
where `[FORMAT]` is one of supported modules (`avro`, `cbor`, `smile` etc)
49+
50+
# Development
51+
52+
## Maintainers
53+
54+
* Author: Tatu Saloranta (@cowtowncoder)
55+
* Active Maintainers:
56+
* Michael Liedtke (@mcliedtke) (Ion backend)
57+
58+
You may at-reference them as necessary but please keep in mind that all
59+
maintenance work is strictly voluntary (no one gets paid to work on this
60+
or any other Jackson components) so there is no guarantee for timeliness of
61+
responses.
62+
63+
## Branches
64+
65+
`master` branch is for developing the next major Jackson version -- 3.0 -- but there
66+
are active maintenance branches in which much of development happens:
67+
68+
* `2.13` is for developing the next 2.x version
69+
* `2.12` and `2.11` are for backported fixes for 2.12/2.11 versions (respectively)
70+
71+
72+
Older branches are usually not changed but are available for historic reasons.
73+
All released versions have matching git tags (`jackson-dataformats-binary-2.10.3`).
74+
75+
Note that since individual format modules used to live in their own repositories,
76+
older branches (before 2.8) and tags do not exist in this repository.
2177

22-
## Other Jackson binary backends
78+
# Other Jackson binary backends
2379

2480
In addition to binary format backends hosted by FasterXML in this repo, there are other
2581
known Jackson backends for binary data formats.
@@ -29,6 +85,6 @@ For example:
2985
* [EXIficient](https://github.com/EXIficient/exificient-for-json) for [Efficient XML Interchange](https://en.wikipedia.org/wiki/Efficient_XML_Interchange)
3086
* [jackson-dataformat-msgpack](https://github.com/msgpack/msgpack-java/tree/develop/msgpack-jackson) for [MessagePack](http://en.wikipedia.org/wiki/MessagePack) (aka `MsgPack`) format
3187

32-
## More
88+
# More
3389

3490
See [Wiki](../../wiki) for more information (javadocs).

0 commit comments

Comments
 (0)