[jackson-jaxrs-providers] 49/162: ...

[Timo Aaltonen]

This is an automated email from the git hooks/post-receive script.

tjaalton pushed a commit to branch master
in repository jackson-jaxrs-providers.

commit cf49b98b6283d3de8c4fb096028b85dc5af0f3b3
Author: Tatu Saloranta <tsaloranta at gmail.com>
Date:   Wed Apr 17 20:14:26 2013 -0700

    ...
---
 README.md | 43 ++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 40 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index c28500d..15d7f0e 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,41 @@
-jackson-jaxrs-providers
-=======================
+## Overview
 
-Multi-module project that contains Jackson-based JAX-RS providers for JSON, XML and Smile formats
\ No newline at end of file
+This is a multi-module project that contains Jackson-based JAX-RS providers for following data formats:
+
+* [JSON](https://github.com/FasterXML/jackson-core)
+* [Smile](https://github.com/FasterXML/jackson-dataformat-smile) (binary JSON)
+* [XML](https://github.com/FasterXML/jackson-dataformat-xml)
+
+Providers implement JAX-RS `MessageBodyReader` and `MessageBodyWriter` handlers for specific
+data formats. They also contain SPI settings for auto-registration.
+
+[![Build Status](https://fasterxml.ci.cloudbees.com/job/jackson-jaxrs-providers-master/badge/icon)](https://fasterxml.ci.cloudbees.com/job/jackson-jaxrs-providers-master/)
+
+## Status
+
+As of Jackson 2.2, this module replaces individual JAX-RS provider modules that were used with earlier Jackson versions.
+
+## Maven dependency
+
+To use JAX-RS on Maven-based projects, use dependencies like:
+
+```xml
+<dependency>
+  <groupId>com.fasterxml.jackson.jaxrs</groupId>
+  <artifactId>jackson-jaxrs-json-provider</artifactId>
+  <version>2.2.0</version>
+</dependency>
+```
+
+(above is for JSON provider; modify appropriately for other providers)
+
+## Usage
+
+Due to auto-registration, it should be possible to simply add Maven dependency
+(or include jar if using other build systems) and let JAX-RS implementation discover
+provider.
+If this does not work you need to consult documentation of the JAX-RS implementation for details.
+
+## Other
+
+For documentation, downloads links, check out [Wiki](../../jackson-jaxrs-providers/wiki)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/jackson-jaxrs-providers.git