X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/96fefe6c6fc2e3bd7e4efbb0b6a7dedb9221aff7..b3a016e9a47d453b5ae4d287d8b6eaafd69971df:/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 90e8cfe005..0a8953a661 100644 --- 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-.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-.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: + +
+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'
+}
+
+ +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/ @@ -124,4 +144,3 @@ $ gradle jar 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 -