14287: Merge branch 'master' into 14287-federated-list

[arvados.git] / doc / sdk / java-v2 / index.html.textile.liquid

diff --git a/doc/sdk/java-v2/index.html.textile.liquid b/doc/sdk/java-v2/index.html.textile.liquid
index 90e8cfe005f86c888aa9ccd565e0f228f4357152..0a8953a66130eeba5aa346cb74b741ca85c5dbba 100644 (file)
--- a/doc/sdk/java-v2/index.html.textile.liquid
+++ b/doc/sdk/java-v2/index.html.textile.liquid
@@ -10,13 +10,33 @@ Copyright (C) The Arvados Authors. All rights reserved.
 SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
-The Arvados Java SDK v2 provides a high level API for working with Arvados resources. It is packaged as a single JAR named
-arvados-java-<version>.jar, e.g. arvados-java-2.0.0.jar
-which can be included in your project using Gradle, Maven, or by hand.
+The Arvados Java SDK v2 provides a high level API for working with Arvados resources.
 
 h2. Using the SDK
 
-FIXME - Add intro text here
+The SDK is packaged as a JAR named @arvados-java-<version>.jar@, which is published to Maven Central and can be included using Maven, Gradle, or by hand.
+
+Here is an example @build.gradle@ file that uses the Arados java sdk:
+
+<pre>
+apply plugin: 'application'
+apply plugin: 'java-library'
+apply plugin: 'maven'
+
+repositories {
+    mavenCentral()
+}
+
+application {
+    mainClassName = "org.arvados.example.CollectionExample"
+}
+
+dependencies {
+    api 'org.arvados:arvados-java-sdk:0.1.0'
+}
+</pre>
+
+See "Java SDK Examples":example.html to get started using the SDK.
 
 h3. Logging
 
@@ -111,8 +131,8 @@ See "Javadoc":javadoc.html
 h2. Building the Arvados SDK
 
 Dependencies:
-* JDK for Java 8 or later https://www.oracle.com/technetwork/java/javase/downloads/index.html
-* Gradle https://gradle.org/install/
+* JDK for Java 8 or later "https://www.oracle.com/technetwork/java/javase/downloads/index.html":https://www.oracle.com/technetwork/java/javase/downloads/index.html
+* Gradle "https://gradle.org/install/":https://gradle.org/install/
 
 
 <notextile>
@@ -124,4 +144,3 @@ $ <code class="userinput">gradle jar</code>
 </pre>
 This will build the SDK and run all unit tests, then generate an Arvados Java sdk jar file in build/libs/arvados-java-2.0.0.jar
 </notextile>
-