Merge pull request square#508 from square/jw/converter-docs

Add simple documentation to each converter.

retrofit-converters/README.md

@@ -8,7 +8,7 @@ To use, supply an instance of your desired converter when building your `RestAda
 
 ```java
 RestAdapter restAdapter = new RestAdapter.Builder()
-    .setEndpoint("https://api.fake.google.com")
+    .setEndpoint("https://api.example.com")
     .setConverter(new ProtoConverter())
     .build();
 ```

retrofit-converters/jackson/README.md

@@ -0,0 +1,10 @@
+Jackson Converter
+=================
+
+A `Converter` which uses [Jackson][1] for serialization to and from JSON.
+
+A default `ObjectMapper` instance will be created or one can be configured and passed to the
+`JacksonConverter` construction to further control the serialization.
+
+
+ [1]: http://wiki.fasterxml.com/JacksonHome

retrofit-converters/protobuf/README.md

@@ -0,0 +1,7 @@
+Google Protocol Buffer Converter
+================================
+
+A `Converter` which uses [Protocol Buffer][1] binary serialization.
+
+
+ [1]: https://developers.google.com/protocol-buffers/

retrofit-converters/simplexml/README.md

@@ -0,0 +1,19 @@
+Simple XML Converter
+====================
+
+A `Converter` which uses [Simple][1] for XML serialization.
+
+A default `Serializer` instance will be created or one can be configured and passed to the
+`SimpleXMLConverter` construction to further control the serialization.
+
+
+Android
+-------
+
+Simple depends on artifacts which are already provided by the Android platform. When specifying as
+a Maven or Gradle dependency, exclude the following transitive dependencies: `stax:stax-api`,
+`stax:stax`, and `xpp3:xpp3`.
+
+
+
+ [1]: http://simple.sourceforge.net/

retrofit-converters/wire/README.md

@@ -0,0 +1,10 @@
+Wire Converter
+==============
+
+A `Converter` which uses [Wire][1] for protocol buffer-compatible serialization.
+
+A default `Wire` instance will be created or one can be configured and passed to the
+`WireConverter` construction to further control the serialization.
+
+
+ [1]: https://github.com/square/wire