Juan Hernandez has uploaded a new change for review. Change subject: sdk: Add some usage documentation ......................................................................
sdk: Add some usage documentation This patch improves the README.md file adding some documentation about how to use the SDK with Maven, and about the dependencies required. Change-Id: Ic4b76369f4573465c6779e249664b104275e99e6 Signed-off-by: Juan Hernandez <juan.hernan...@redhat.com> (cherry picked from commit 25eddda411974849fbb3ea423298e085b1dd2ada) --- M ovirt-engine-sdk-java/README.md 1 file changed, 25 insertions(+), 1 deletion(-) git pull ssh://gerrit.ovirt.org:29418/ovirt-engine-sdk-java refs/changes/91/35091/1 diff --git a/ovirt-engine-sdk-java/README.md b/ovirt-engine-sdk-java/README.md index 99584d9..101dacd 100644 --- a/ovirt-engine-sdk-java/README.md +++ b/ovirt-engine-sdk-java/README.md @@ -4,9 +4,33 @@ Introduction ------------ -The oVirt Python SDK is a Python library that simplfies access to the oVirt +The oVirt Java SDK is a Java library that simplfies access to the oVirt Engine REST API. +Using +----- + +If you want to use the Java SDK in your application you will need the +`.jar` file and its dependencies. The Java SDK is available in Maven +central, so the easiest way to get it and its dependencies is to include +a `dependency` element inside your own `pom.xml` file: + + <dependency> + <groupId>org.ovirt.engine.sdk</groupId> + <artifactId>ovirt-engine-sdk-java</artifactId> + <version>3.5.0.5</version> + </dependency> + +If you aren't using Maven to manage your dependencies you will need to +get the dependencies manually and add them to the class path of your +application. Currently the SDK uses the following Java libraries: + +- [Apache Commons BeanUtils](http://commons.apache.org/proper/commons-beanutils) +- [Apache Commons Codec](http://commons.apache.org/proper/commons-codec) +- [Apache Commons Logging](http://commons.apache.org/proper/commons-logging) +- [Apache HTTP Components](http://hc.apache.org) +- [Apache log4j 1.2](http://logging.apache.org/log4j/1.2) + Generating ---------- -- To view, visit http://gerrit.ovirt.org/35091 To unsubscribe, visit http://gerrit.ovirt.org/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ic4b76369f4573465c6779e249664b104275e99e6 Gerrit-PatchSet: 1 Gerrit-Project: ovirt-engine-sdk-java Gerrit-Branch: sdk_3.5 Gerrit-Owner: Juan Hernandez <juan.hernan...@redhat.com> _______________________________________________ Engine-patches mailing list Engine-patches@ovirt.org http://lists.ovirt.org/mailman/listinfo/engine-patches
