Skip to content

Commit

Permalink
Add download info to adapters and converters.
Browse files Browse the repository at this point in the history
  • Loading branch information
ersin-ertan authored and JakeWharton committed Dec 7, 2016
1 parent ed82280 commit b8768b2
Show file tree
Hide file tree
Showing 12 changed files with 310 additions and 2 deletions.
30 changes: 30 additions & 0 deletions retrofit-adapters/guava/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Guava Adapter
==============

An `Adapter` for adapting [Guava][1] types.


Download
--------

Download [the latest JAR][2] or grab via [Maven][3]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>adapter-guava</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][3]:
```groovy
compile 'com.squareup.retrofit2:adapter-guava:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: https://github.com/google/guava
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=adapter-guava&v=LATEST
[3]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22adapter-guava%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
30 changes: 30 additions & 0 deletions retrofit-adapters/java8/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Java8 Adapter
==============

An `Adapter` for adapting [Java8][1] types.


Download
--------

Download [the latest JAR][2] or grab via [Maven][3]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>adapter-java8</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][3]:
```groovy
compile 'com.squareup.retrofit2:adapter-java8:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: http://www.oracle.com/technetwork/java/javase/jdk-8-readme-2095712.html
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=adapter-java8&v=LATEST
[3]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22adapter-java8%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
30 changes: 30 additions & 0 deletions retrofit-adapters/rxjava/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Java8 Adapter
==============

An `Adapter` for adapting [RxJava 1.x][1] types.


Download
--------

Download [the latest JAR][2] or grab via [Maven][3]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>adapter-rxjava</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][3]:
```groovy
compile 'com.squareup.retrofit2:adapter-rxjava:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: https://github.com/ReactiveX/RxJava/tree/1.x
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=adapter-rxjava&v=LATEST
[3]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22adapter-rxjava%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
30 changes: 30 additions & 0 deletions retrofit-adapters/rxjava2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Java8 Adapter
==============

An `Adapter` for adapting [RxJava 2.x][1] types.


Download
--------

Download [the latest JAR][2] or grab via [Maven][3]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>adapter-rxjava2</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][3]:
```groovy
compile 'com.squareup.retrofit2:adapter-rxjava2:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: https://github.com/ReactiveX/RxJava/tree/2.x
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=adapter-rxjava2&v=LATEST
[3]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22adapter-rxjava2%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
25 changes: 24 additions & 1 deletion retrofit-converters/gson/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,30 @@ Gson Converter
A `Converter` which uses [Gson][1] for serialization to and from JSON.

A default `Gson` instance will be created or one can be configured and passed to the
`GsonConverter` construction to further control the serialization.
`GsonConverterFactory` to further control the serialization.


Download
--------

Download [the latest JAR][2] or grab via [Maven][3]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>converter-gson</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][3]:
```groovy
compile 'com.squareup.retrofit2:converter-gson:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: https://github.com/google/gson
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=converter-gson&v=LATEST
[3]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22converter-gson%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
25 changes: 24 additions & 1 deletion retrofit-converters/jackson/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,30 @@ 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.
`JacksonConverterFactory` construction to further control the serialization.


Download
--------

Download [the latest JAR][2] or grab via [Maven][3]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>converter-jackson</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][3]:
```groovy
compile 'com.squareup.retrofit2:converter-jackson:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: http://wiki.fasterxml.com/JacksonHome
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=converter-jackson&v=LATEST
[3]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22converter-jackson%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
23 changes: 23 additions & 0 deletions retrofit-converters/moshi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,27 @@ A default `Moshi` instance will be created or one can be configured and passed t
`MoshiConverterFactory.create()` to further control the serialization.


Download
--------

Download [the latest JAR][2] or grab via [Maven][3]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>converter-moshi</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][3]:
```groovy
compile 'com.squareup.retrofit2:converter-moshi:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: https://github.com/square/moshi
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=converter-moshi&v=LATEST
[3]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22converter-moshi%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
23 changes: 23 additions & 0 deletions retrofit-converters/protobuf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,27 @@ Google Protocol Buffer Converter
A `Converter` which uses [Protocol Buffer][1] binary serialization.


Download
--------

Download [the latest JAR][2] or grab via [Maven][3]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>converter-protobuf</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][3]:
```groovy
compile 'com.squareup.retrofit2:converter-protobuf:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: https://developers.google.com/protocol-buffers/
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=converter-protobuf&v=LATEST
[3]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22converter-protobuf%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
25 changes: 25 additions & 0 deletions retrofit-converters/scalars/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,28 @@ Java Scalars Converter

A `Converter` which supports converting strings and both primitives and their boxed types to
`text/plain` bodies.


Download
--------

Download [the latest JAR][1] or grab via [Maven][2]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>converter-scalars</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][2]:
```groovy
compile 'com.squareup.retrofit2:converter-scalars:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=converter-scalars&v=LATEST
[2]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22converter-scalars%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
22 changes: 22 additions & 0 deletions retrofit-converters/simplexml/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,27 @@ a Maven or Gradle dependency, exclude the following transitive dependencies: `st
`stax:stax`, and `xpp3:xpp3`.


Download
--------

Download [the latest JAR][2] or grab via [Maven][3]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>converter-simplexml</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][3]:
```groovy
compile 'com.squareup.retrofit2:converter-simplexml:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: http://simple.sourceforge.net/
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=converter-simplexml&v=LATEST
[3]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22converter-simplexml%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
23 changes: 23 additions & 0 deletions retrofit-converters/wire/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,27 @@ Wire Converter
A `Converter` which uses [Wire][1] for protocol buffer-compatible serialization.


Download
--------

Download [the latest JAR][2] or grab via [Maven][3]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>converter-wire</artifactId>
<version>latest.version</version>
</dependency>
```
or [Gradle][3]:
```groovy
compile 'com.squareup.retrofit2:converter-wire:latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].



[1]: https://github.com/square/wire
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=converter-wire&v=LATEST
[3]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup.retrofit2%22%20a%3A%22converter-wire%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
26 changes: 26 additions & 0 deletions retrofit-mock/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Mock Web Server
==============

An mock web server for mocking HTTP responses from a server, and simulating network behaviour.

Download
--------

Download [the latest JAR][1] or grab via [Maven][2]:
```xml
<dependency>
<groupId>com.squareup.retrofit2</groupId>
<artifactId>retrofit-mock</artifactId>
<version>see.latest.version</version>
</dependency>
```
or [Gradle][1]:
```groovy
compile 'com.squareup.retrofit2:retrofit-mock:see.latest.version'
```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].

[1]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=retrofit-mock&v=LATEST
[2]: http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22retrofit-mock%22
[snap]: https://oss.sonatype.org/content/repositories/snapshots/

0 comments on commit b8768b2

Please sign in to comment.