[jackson-annotations] 32/207: ...

[Timo Aaltonen]

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

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

commit 4beddcacf1d14975260ca0a14a0c0b5d34116ceb
Author: Tatu Saloranta <tsaloranta at gmail.com>
Date:   Fri Mar 2 20:43:14 2012 -0800

    ...
---
 README.md | 38 +++++++++++++++++++++++++++++++++-----
 1 file changed, 33 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 791030a..00fc560 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,43 @@
 # Overview
 
-This project contains core genera-purpose annotations for
+This project contains general purpose annotations for
 Jackson Data Processor, used on value and handler types.
-Only those annotations that have no dependencies to other core
-packages are included here: so anything that does depend on
-'jackson-databind' package are included in that package
-and so forth.
+The only annotations not included are ones that require dependency
+to the [Databind package](/FasterXML/jackson-databind).
 
 Project contains versions 2.0 and above: source code for earlier (1.x) versions is available from [Codehaus](http://jackson.codehaus.org) SVN repository.
 Note that with version 1.x these annotations were part of the 'core jar'.
 
+## Basic Usage
+
+### Improvements over typical Java annotations
+
+In addition to regular usage (see below), there are couple of noteworthy improvements Jackson does:
+
+* [Mix-in annotations](wiki/MixinAnnotations) allow associating annotations on third-party classes ''without modifying classes''.
+* Jackson annotations support full inheritance: meaning that you can ''override annotation definitions'', and not just class annotations but also method/field annotations!
+
+### Renaming properties
+
+One of most common tasks is to change JSON name used for a property: for example:
+
+    public class POJO {
+      @JsonProperty("firstName")
+      public String _first_name;
+    }
+
+would result in JSON like:
+
+    { "firstName" : "Bob" }
+
+instead of
+
+    { "_first_name" : "Bob"
+
+### Ignoring properties
+
+### Handling polymorphic types
+
 # Further reading
 
 * [Jackson Project Home](http://wiki.fasterxml.com/JacksonHome)

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