readme updates

Author: markxnelson

README.md

@@ -17,13 +17,22 @@ The following features are planned for the next few releases:
   sidecar, e.g. fluentd or Logstash,
 * Provide the ability to publish other logs (i.e. other than the server logs).
 
+## Contents
+
+* How to [download the release](#download-the-release)
+* How to [build from source](#building-from-source)
+* How to [install](#installation) the WebLogic Logging exporter
+* How to [contribute](#contributing) to this project
+* [License](#license) information
+
 
 ## 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.
 
+
 ## Download the release
 
 You can download the WebLogic Logging Exporter already compiled for you from the
@@ -199,11 +208,55 @@ git clone git@orahub.oraclecorp.com:oracle/wls-logging-exporter.git
 mvn install
 ```
 
-The `weblogic-logging-exporter-0.1-SNAPSHOT.jar` will be available under the `target` directory.
+The `weblogic-logging-exporter-0.1.jar` will be available under the `target` directory.
+
+## Installation
+
+This section outlines the steps that are required to add the Weblogic Logging Exporter to Weblogic Server.
+
+1. Download or build the WebLogic Logging Exporter as described above.
+
+1. Copy the `weblogic-logging-exporter-0.1.jar` into a suitable location, e.g. into your domain directory.
+
+1. Add a startup class to your domain configuration.
+
+   * In the administration console, navigate to "Environment" then "Startup and Shutdown classes" in the main menu.
+   * Add a new Startup class, you may choose any descriptive name, and the class name must be
+     `weblogic.logging.exporter.Startup`.
+   * Target the startup class to each server that you want to export logs from.
 
-## Deployment
+   You can verify this by checking for the update in your `config.xml` which should be similar to this example:
+
+    ```
+    <startup-class>
+        <name>LoggingExporterStartupClass</name>
+        <target>AdminServer</target>
+        <class-name>weblogic.logging.exporter.Startup</class-name>
+    </startup-class>
+    ```
+
+1. Add `weblogic-logging-exporter.jar` and `snakeyaml.jar` to your classpath
+
+This project requires the YAML  parser  to parse the configuration file.   Thus you also need to add the
+snakeyaml.jar to your class path.   If you have build the project yourself,  the jar should be available as
+repository/org/yaml/snakeyaml/1.19/snakeyaml-1.19.jar,  or you can download that from
+https://jar-download.com/artifacts/org.yaml/snakeyaml/1.19/source-code
+
+You may want to create a file named "WebLogicLoggingExporter.yaml"  and put it under the config directory
+of domain home. This is the default location.  Or you can specify a system variable named
+"WEBLOGIC_LOGGING_EXPORTER_CONFIG_FILE" and have it pointed to the configuration file.
+Refer to the later section for the content of this file.
+
+Restart the domain,  the domain logs will be posted to ElasticSearch.   You can do the following curl
+command to verify that domain logs has been posted to Elasticsearch.   The default index name is "wls",
+and docs.count should be greater than 0 indicating that log entries is being sent to ElasticSearch.
+
+```
+$ curl "localhost:9200/_cat/indices?v"
+health status index               uuid pri rep docs.count docs.deleted store.size pri.store.size
+yellow open   wls                 q4Q2v2dXTBOyYsHZMdDe3H 5   1         23            0      101kb          101kb
+```
 
-TBD.  Update how to integrate this JAR into WebLogic Kubernetes operator.
 
 ## Contributing