SUPPO-1256: A few more updates to the docs.

Author: seth-mg

DEVELOPER.md

@@ -0,0 +1,28 @@
+## Developer Notes
+
+#### Building and Releasing
+To be updated..
+
+
+#### Internal Releasing
+TBD..
+
+#### Old Stuff
+[Docker](examples/docker) bits for running examples.  Maybe just remove?
+
+A duplicate copy of the examples docker notes is below...
+
+Docker files can be found [here](https://github.com/rosette-api/java/tree/master/examples/docker)
+
+To simplify the running of the Java examples, the Dockerfile will build an image and install the rosette-api library from the *published source*.
+
+Build the docker image, e.g. `docker build --rm -t basistech/java:1.1 .`
+
+Run an example as `docker run --rm -e API_KEY=api-key -v "path-to-java-dir:/source" basistech/java:1.1`
+
+To test against a specific source file, add `-e FILENAME=filename` before the `-v`.
+To test against an alternate url, add `-e ALT_URL=alternate_url`.
+
+#### TODOs
+...
+

README.md

@@ -35,7 +35,7 @@ them without consultation with Basis Technology Corp.
 
 #### Examples
 View small example programs for each Rosette endpoint in the
-[examples](https://github.com/rosette-api/java/tree/master/examples/src/main/java/com/basistech/rosette/examples) directory.
+[examples](examples/src/main/java/com/basistech/rosette/examples) directory.
 
 #### Documentation & Support
 - [Binding API](https://rosette-api.github.io/java/)
@@ -44,8 +44,8 @@ View small example programs for each Rosette endpoint in the
 - [Rosette Platform Release Notes](https://support.rosette.com/hc/en-us/articles/360018354971-Release-Notes)
 - [Binding/Rosette Platform Compatibility](https://developer.rosette.com/features-and-functions?java#)
 - [Support](https://support.rosette.com)
-- [Binding License: Apache 2.0](https://github.com/rosette-api/java/blob/develop/LICENSE.txt)
+- [Binding License: Apache 2.0](LICENSE.txt)
 
 ## Binding Developer Information
-If you are modifying the binding code, please refer to the [developer README](https://github.com/rosette-api/java/tree/develop/DEVELOPER.md) file.
+If you are modifying the binding code, please refer to the [developer README](DEVELOPER.md) file.
 

examples/src/main/java/com/basistech/rosette/examples/README.md

@@ -1,35 +1,17 @@
-Rosette API Java Examples
-=========================
-
-Each example class can be run independently.
-
+## Endpoint Examples
 Each example file demonstrates one of the capabilities of the Rosette Platform.
 
-A note on prerequisites. Rosette API only suports TLS 1.2 so ensure your toolchain also supports it.
-
-## Maven ##
-If you use Maven, everything should have been setup and you can start running the examples using `mvn exec:java`.
-Otherwise you can compile and run these examples by hand:
-
-- make sure you have JRE 1.7+, verify by `java -version`
-- download <TODO: nexus url>
-- `cd src/main/java/com/basistech/rosette/examples`
-- `javac -cp .:<path-to-rosette-api-jar-file> *.java`
-- `java -cp .:<path-to-rosette-api-jar-file> -Drosette.api.key=<your-api-key> com.basistech.rosette.examples.<XyzExample>`
-
-## Docker ##
-Docker files can be found [here](https://github.com/rosette-api/java/tree/master/examples/docker)
-
-### Summary
-To simplify the running of the Java examples, the Dockerfile will build an image and install the rosette-api library from the *published source*.
-
-### Basic Usage
-Build the docker image, e.g. `docker build --rm -t basistech/java:1.1 .`
-
-Run an example as `docker run --rm -e API_KEY=api-key -v "path-to-java-dir:/source" basistech/java:1.1`
-
-To test against a specific source file, add `-e FILENAME=filename` before the `-v`.
-To test against an alternate url, add `-e ALT_URL=alternate_url`.
+Here are some methods for running the examples. Each example will also accept an optional `-Drosette.api.altUrl`
+parameter for overriding the default URL.
 
+A note on prerequisites. Rosette API only supports TLS 1.2 so ensure your toolchain also supports it.
 
+#### Running from Local Source
 
+```
+git clone [email protected]:rosette-api/java.git
+cd java
+mvn compile
+cd examples
+mvn exec:java -Dexec.mainClass="com.basistech.rosette.examples.PingExample" -Drosette.api.key=$API_KEY
+```