readme updates

Author: markxnelson

README.md

@@ -1,29 +1,82 @@
 # WebLogic Logging Exporter
 
-The WebLogic Logging Exporter (the "logging exporter") adds a log event handler to WebLogic Server, such that WLS server logs can be integrated into [Elastic Stack](https://www.elastic.co/products) in Kubernetes directly,  by using the [Elasticsearch](https://www.elastic.co/products/elasticsearch) REST API.  
+The WebLogic Logging Exporter (the "logging exporter") adds a log event handler to WebLogic Server,
+such that WLS server logs can be integrated into [Elastic Stack](https://www.elastic.co/products)
+in Kubernetes directly,  by using the [Elasticsearch](https://www.elastic.co/products/elasticsearch) REST API.
 
-The blog, [Let WebLogic work with Elastic Stack in Kubernetes](https://blogs.oracle.com/weblogicserver/let-weblogic-work-with-elk-in-kubernetes), outlines the steps to harvest WLS server logs using Logstash so that they can be filtered, manipulated, and viewed using Elasticsearch and Kibana.
-However, that approach requires the setup of a shared volume which is outside of the pod, and the logs needs to be written to an intermediate log file for harvesting and parsing.
-
-The goal of this project is to provide an easy to configure, robust, and production-ready solution to access WLS log information through Elasticsearch and Kibana.
+The goal of this project is to provide an easy to configure, robust, and production-ready solution to access
+WLS log information through Elasticsearch and Kibana.
 
 ## Getting Started
 
 These instructions outline the steps to build the `weblogic-logging-exporter.jar` file, which can then be integrated into the [WebLogic Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator/) for handling the server logs generated by the WebLogic Server domain.
 
-## Prerequisites
+## Download the release
+
+You can download the WebLogic Logging Exporter already compiled for you from the [releases page]().
+
+## Building from source
+
+If you prefer, you can build the WebLogic Logging Exporter from the source code.  To do this, you will
+need access to some WebLogic Server libraries.  There are two ways to get these libraries:
+
+* Populate you local Maven repository with the required files from a local WebLogic Server installation
+  using the Oracle Maven Synchronization plugin, or
+* Use the Oracle Maven repository to download them as part of your build, this requires registration and
+  configuring your local Maven installation with the appropriate authentication details.
+
+### Populating your local Maven repository from a local WebLogic Server installation
+
+You can use the Oracle Maven Synchronization plugin, which is included in your WebLogic Server installation,
+to install the necessary dependencies into your local Maven repository.
+
+There are two steps:
+
+* Install the Oracle Maven Synchronization plugin,
+* Run the "push" goal to populate your local Maven repository from your WebLogic Server installation.
+
+#### Installing the Oracle Maven Synchronization plugin
+
+To install the plugin, navigate to your WebLogic Server installation then enter the commands (this example
+assumes you installed WebLogic Server in /u01/wlshome):
+
+```
+cd /u01/wlshome/oracle_common/plugins/maven/com/oracle/12.2.1/oracle-maven-sync
+mvn install:install-file -DpomFile=oracle-maven-sync-12.2.1.pom -Dfile=oracle-maven-sync-12.2.1.jar
+```
+
+#### Popoulating your local Maven repository
+
+To populate your local Maven repository from your WebLogic Server installation, enter this command:
+
+```
+mvn com.oracle.maven:oracle-maven-sync:push -DoracleHome=/u01/wlshome
+```
+
+You can verify the dependencies were installed by looking in your local Maven repository which is
+normally located at `~/.m2/repository/com/oracle/weblogic`.
+
 
-The logging exporter depends on the WebLogic logging JAR which is available from the [ Oracle Maven Repository](http://maven.oracle.com/).
+### Using the Oracle Maven repository
 
-To access the Oracle Maven Repository, there are two fundamental requirements to be aware of:
+Note: If you populated your local repository using the Oracle Maven Synchronization plugin, then this
+step is *not* required.
 
-1. You must be using [Maven 3.2.5](http://maven.apache.org/docs/3.2.5/release-notes.html) or later.  This contains the version of the [Wagon 2.8](http://maven.apache.org/wagon/) component that has been enhanced to support access to artifacts that are protected by [HTTP authentication schemes](https://issues.apache.org/jira/projects/WAGON/issues/WAGON-422).
+To access the Oracle Maven repository, there are two requirements to be aware of:
 
-2. You must be registered with OTN and have accepted the license agreement to access and use the Oracle Maven Repository.  This can be done with either a new or an existing OTN user account by accessing the http://maven.oracle.com site and selecting the registration link.  
-After registering, then you just need to configure your local Maven environment with the details of the Oracle Maven Repository, including the information that relates to the authentication model specifying your OTN user name and password.
+1. You must be using [Maven 3.2.5](http://maven.apache.org/docs/3.2.5/release-notes.html) or later.
+This contains the version of the [Wagon 2.8](http://maven.apache.org/wagon/) component that has
+been enhanced to support access to artifacts that are protected by
+[HTTP authentication schemes](https://issues.apache.org/jira/projects/WAGON/issues/WAGON-422).
 
-## Building
-### Configure Maven
+2. You must be registered with OTN and have accepted the license agreement to access and use the
+Oracle Maven Repository.  This can be done with either a new or an existing OTN user account by
+accessing the http://maven.oracle.com site and selecting the registration link.
+After registering, then you just need to configure your local Maven environment with the details
+of the Oracle Maven Repository, including the information that relates to the authentication model
+specifying your OTN user name and password.
+
+#### Configure Maven
 
 #### 1. Encrypt your OTN Password.
 
@@ -123,13 +176,17 @@ To configure the HTTP Wagon, add the following `<server>` element to the `<serve
 
 If needed, specify the `proxies` that are required.
 
-#### 3. Clone the project and build it.
+### Building the WebLogic Logging Exporter
+
+To build the WebLogic Logging Exporter, simply clone the project from GitHub and then build it
+with Maven:
+
 ```
 git clone git@orahub.oraclecorp.com:oracle/wls-logging-exporter.git
 mvn install
 ```
 
-The `weblogic-logging-exporter-1.0-SNAPSHOT.jar` will be available under the `target` directory.
+The `weblogic-logging-exporter-0.1-SNAPSHOT.jar` will be available under the `target` directory.
 
 ## Deployment