mark as deprecated

README.md

@@ -1,49 +1,5 @@
-## Overview
+**NOTE**: This module has become part of [Jackson Binary Dataformats](../../../jackson-dataformats-binary)
+as of Jackson 2.8
 
-This Jackson extension handles reading and writing of data encoded in [Smile](http://wiki.fasterxml.com/SmileFormatSpec) data format ("binary JSON").
-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).
-
-[![Build Status](https://travis-ci.org/FasterXML/jackson-dataformat-smile.svg?branch=master)](https://travis-ci.org/FasterXML/jackson-dataformat-smile)
-[![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/)
-[![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)
-
-## Status
-
-Module has been mature since Jackson 1.6.
-
-## Maven dependency
-
-To use this module on Maven-based projects, use following dependency:
-
-```xml
-<dependency>
-  <groupId>com.fasterxml.jackson.dataformat</groupId>
-  <artifactId>jackson-dataformat-smile</artifactId>
-  <version>2.7.0</version>
-</dependency>
-```
-
-(or whatever version is most up-to-date at the moment)
-
-## Usage
-
-Basic usage is by using `SmileFactory` in places where you would usually use `JsonFactory`:
-
-```java
-SmileFactory f = new SmileFactory();
-// can configure instance with 'SmileParser.Feature' and 'SmileGenerator.Feature'
-ObjectMapper mapper = new ObjectMapper(f);
-// and then read/write data as usual
-SomeType value = ...;
-byte[] smileData = mapper.writeValueAsBytes(value);
-SomeType otherValue = mapper.readValue(smileData, SomeType.class);
-```
-
-## Related
-
-* [Smile-format discussion group](https://groups.google.com/forum/#!forum/smile-format-discussion)
-* Non-java Smile codecs (for interoperability):
-    * C: [libsmile](https://github.com/pierre/libsmile) (with wrappers for Ruby, Perl)
-    * Clojure: [Cheshire](https://github.com/dakrone/cheshire)
-    * Javascript: [smile-js](https://github.com/ngyewch/smile-js)
-    * Python [PySmile](https://github.com/jhosmer/PySmile)
+This repo still exists to allow release of patch versions of older versions; it will be hidden (made private)
+in near future.