From b59e6e9d6207bba0b2f5603754739b54cd953210 Mon Sep 17 00:00:00 2001 From: Ivan Date: Tue, 14 Jul 2020 19:52:44 -0700 Subject: [PATCH] Tweak README for public release --- README.md | 48 ++++-------------------------------------------- 1 file changed, 4 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 0309815..f903238 100644 --- a/README.md +++ b/README.md @@ -17,53 +17,13 @@ Building the API client library requires: ## Installation -To install the API client library to your local Maven repository, simply execute: +The accompanying JAR file `sysml-v2-api-client-*-all.jar` includes all dependencies required to run it. You can add it to an existing project via Maven, Gradle, sbt, etc. in the standard manner for the tool. -```shell -mvn clean install -``` - -To deploy it to a remote Maven repository instead, configure the settings of the repository and execute: - -```shell -mvn clean deploy -``` - -Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information. - -### Maven users - -Add this dependency to your project's POM: - -```xml - - org.omg.sysml - sysml-v2-api-client - 2020-06 - compile - -``` - -### Gradle users - -Add this dependency to your project's build file: - -```groovy -compile "org.omg.sysml:sysml-v2-api-client:2020-06" -``` - -### Others - -At first generate the JAR by executing: - -```shell -mvn clean package -``` +### JShell Quickstart -Then manually install the following JARs: +If you are using Java 9+ you can use [JShell](http://cr.openjdk.java.net/~rfield/tutorial/JShellTutorial.html) to quickly interact with the client. -* `target/sysml-v2-api-client-2020-06.jar` -* `target/lib/*.jar` +`jshell --classpath /path/to/sysml-v2-api-client-*-all.jar` ## Getting Started