Skip to content

Commit 854b225

Browse files
committed
update Smile README with better links
1 parent b1b34e0 commit 854b225

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

smile/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
## Overview
22

3-
This Jackson extension handles reading and writing of data encoded in [Smile](http://wiki.fasterxml.com/SmileFormatSpec) data format ("binary JSON").
3+
This Jackson extension handles reading and writing of data encoded in [Smile](https://github.com/FasterXML/smile-format-specification)
4+
data format ("binary JSON").
45
It extends standard Jackson streaming API (`JsonFactory`, `JsonParser`, `JsonGenerator`), and as such works seamlessly with all the higher level data abstractions (data binding, tree model, and pluggable extensions).
56

67
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.dataformat/jackson-dataformat-smile/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.dataformat/jackson-dataformat-smile/)
78
[![Javadoc](https://javadoc-emblem.rhcloud.com/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-smile/badge.svg)](http://www.javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-smile)
89

910
## Status
1011

11-
Module has been mature since Jackson 1.6.
12+
Module has been mature since Jackson 1.6, and is used widely ([over 150 projects](http://mvnrepository.com/artifact/com.fasterxml.jackson.dataformat/jackson-dataformat-smile)), often as a dynamically configurable alternative to textual JSON.
13+
14+
It also works very well for use cases like caching, especially when databinding is configured to
15+
[serialize POJOs as Arrays](https://medium.com/@cowtowncoder/serializing-java-pojo-as-json-array-with-jackson-2-more-compact-output-510a85c019d4) which can further reduce size of serialized objects.
1216

1317
## Maven dependency
1418

@@ -18,7 +22,7 @@ To use this module on Maven-based projects, use following dependency:
1822
<dependency>
1923
<groupId>com.fasterxml.jackson.dataformat</groupId>
2024
<artifactId>jackson-dataformat-smile</artifactId>
21-
<version>2.7.0</version>
25+
<version>2.8.9</version>
2226
</dependency>
2327
```
2428

@@ -29,10 +33,9 @@ To use this module on Maven-based projects, use following dependency:
2933
Basic usage is by using `SmileFactory` in places where you would usually use `JsonFactory`:
3034

3135
```java
32-
SmileFactory f = new SmileFactory();
33-
// can configure instance with 'SmileParser.Feature' and 'SmileGenerator.Feature'
34-
ObjectMapper mapper = new ObjectMapper(f);
35-
// and then read/write data as usual
36+
ObjectMapper mapper = new ObjectMapper(new SmileFactory());
37+
// (or can construct factory, configure instance with 'SmileParser.Feature'
38+
// and 'SmileGenerator.Feature' first
3639
SomeType value = ...;
3740
byte[] smileData = mapper.writeValueAsBytes(value);
3841
SomeType otherValue = mapper.readValue(smileData, SomeType.class);

0 commit comments

Comments
 (0)