From 75c3dcda61c9edc0709bf6779d34af3601e5d8eb Mon Sep 17 00:00:00 2001
From: Aidan Hahn <aidan@aidanis.online>
Date: Sun, 19 May 2019 14:39:41 -0700
Subject: [PATCH] updated README.md

---
 README.md                                | 30 +++++++++++++++++-------
 src/main/java/JobServ/JobServClient.java |  8 ++++---
 2 files changed, 26 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 053c311..e778875 100644
--- a/README.md
+++ b/README.md
@@ -3,21 +3,33 @@ Remote Procedure Calls over the protobuf API
 
 # Requirements
 - openssl
+- tar
 
 # Building
 Gradle will manage dependencies, generate code, compile the java, and package the code.
 Simply run the folllowing command:
 ```shell
-$ gradle clean build 
+$ ./buildwrapper.sh
 ```
-Gradle will package both the client and server into both a zip and a tarball. 
-The tarball is located in build/distributions. After extracting one of the archives on a target machine the following commands will run JobServ.
-Make sure you are in the directory you extracted the archive to.
-```shell
-$ ./bin/jobserv-server
-$ ./bin/jobserv-client (host) (port)
+buildwrapper will ask you for details about the client and server, if you are testing this software both CNs can be set to localhost.
+buildwrapper will then generate CAs for the Client and Server, and signed certs for the Client and Server. IN addition a seperate, third CA and cert will be generated for testing purposes.
+Gradle will then generate protobuf source and compile it with the source for the client and server.
+After gradle is completed buildwrapper will organize the sources with their respective certs in the staging folder. In addition to a server folder and a client folder, there will be a test folder which has a copy of all certs and both server and client functionality. The test CA is not trusted by the server or the client by default. As such, the test cert can be used to induce a mutual tls authentication failure.
+
+# Running
+After build, the programs can be found in the staging folder.
+After changing directory to the 'staging/client' folder or the 'staging/server' folder, either program can be run as follows:
+
+```
+$ ./JobServ/bin/jobserv-server (port) server.crt private.pem ca.crt
+$ ./JobServ/bin/jobserv-client private.pem client.crt ca.crt (hostname) (port) (command) (arguments)
+```
+alternatively, for guidance: 
+
+```
+$ ./JobServ/bin/jobserv-server 
+$ ./JobServ/bin/jobserv-client help
 ```
-(TODO: seperate archives for client and server)
 
 # Testing
-(TODO: tests for mtls, job control module)
+(TODO: job control module)
diff --git a/src/main/java/JobServ/JobServClient.java b/src/main/java/JobServ/JobServClient.java
index b1839f5..7ec17f6 100644
--- a/src/main/java/JobServ/JobServClient.java
+++ b/src/main/java/JobServ/JobServClient.java
@@ -211,14 +211,12 @@ public class JobServClient {
      * Parses arguments and calls the correct function
      */
     public static void main(String[] args) throws Exception {
-        if (args.length == 1 && args[0] == "help"){
-            outputHelp();
-        }
 
         // check args
         if (args.length < 7) {
             System.out.println("Usage: $ ./jobserv-client privatekey, cert, truststore, host, port, command, args");
             System.out.println("Or try $ ./jobserv-client help");
+            outputHelp();
             return;
         }
 
@@ -342,6 +340,10 @@ public class JobServClient {
             }
         }
 
+    /*
+     * outputHelp()
+     * writes help information about all commands in the shell to screen
+     */
     public static void outputHelp() {
         System.out.println("... new (command)");
         System.out.println("Starts a new process on the server");