SCFF-44 adding details to Readme file regarding filtering

Author: nmillalaf

README.md

@@ -35,6 +35,7 @@ Flags:
   --version                      Show application version.
 ```
 
+
 There are two ways to run this Nozzle:
 
 1. Run as standalone app
@@ -48,6 +49,28 @@ godep go run main.go --sumo-endpoint=https://sumo-endpoint --api-endpoint=https:
 
 If everything goes right, you should see in your terminal the _Nozzle's Logs_ and, in the __Sumo Logic endpoint__ (defined in the _--sumo-endpoint_ flag) you should see the logs according the events you choose (_'LogMessage'_ and _'ValueMetric'_ with _verbose_ in this case).
 
+
+### Filtering Option
+
+There is a lot of Events coming from Cloud Foundry and, in most of the cases, we will only want to see **some** of them or **exclude** some of them, in this cases the filtering flags are useful.
+
+If you want to include only the events that contains:
+
+* job: diego_cell
+* source_type: app
+
+and you are not interested in the events that contains:
+
+* source_type:other
+* unit:count
+
+The correct way of using those flags will be:
+
+```
+godep go run main.go --sumo-endpoint=https://sumo-endpoint --api-endpoint=https://api.endpoint --cloudfoundry-user=some_user --cloudfoundry-password=some_password --sumo-post-minimum-delay=200ms --log-events-batch-size=200 --events=LogMessage, ValueMetric   --include-only-matching-filter=job:diego_cell,source_type:app --exclude-always-matching-filter=source_type:other,unit:count
+```
+
+
 ### Run as a tile in Pivotal Cloud Foundry
 
 **Pivotal Cloud Foundry** (PCF) has a Tile Generator tool which will help you to deploy this Nozzle in PCF allowing an easy configuration of it.

tile.yml

@@ -2,9 +2,9 @@
 # The high-level description of your tile.
 # Replace these properties with real values.
 #
-name: firehose-to-sumologic # By convention lowercase with dashes
+name: sumo-logic-nozzle # By convention lowercase with dashes
 icon_file: resources/sumo_128x128-B.png
-label: Sumo Logic Firehose Nozzle for PCF
+label: Sumo Logic Nozzle for PCF
 description: Forward firehose logs to Sumo Logic
 
 # Global defaults (all optional)
@@ -31,7 +31,7 @@ packages:
   manifest:
     # any options that you would normally specify in a cf manifest.yml, including</i>
     buildpack: https://github.com/cloudfoundry/go-buildpack.git
-    command: sumo-logic-nozzle
+    command: firehose-to-sumologic
     path: sumo-logic-nozzle.zip
   health_check: none
   needs_cf_credentials: true
@@ -89,6 +89,10 @@ forms:
   label: Cloud Foundry Settings
   description: Cloud Foundry Settings details
   properties:
+  - name: api-endpoint
+    type: string
+    label: Cloud Foundry API Endpoint
+    description: API endpoint for CF
   - name: cloudfoundry-user
     type: string
     label: Cloud Foundry User
@@ -97,10 +101,6 @@ forms:
     type: secret
     label: Cloud Foundry Password
     description: Password for API user
-  - name: api-endpoint
-    type: string
-    label: Cloud Foundry API Endpoint
-    description: API endpoint for CF
   - name: log-events-batch-size
     type: string
     label: Log Events Batch Size
@@ -111,6 +111,11 @@ forms:
     label: Comma separated list of events you would like (Default is "LogMessage")
     default: LogMessage
     description: Valid options are Error, ContainerMetric, HttpStart, HttpStop, HttpStartStop, LogMessage, ValueMetric, CounterEvent
+  - name: verbose-log-messages
+    type: boolean
+    label: Verbose in 'LogMessage' event
+    default: true
+    description: If is not checked, it will send only the LogMessage and the App id
   - name: nozzle-polling-period
     type: string
     label: Nozzle Polling Period
@@ -122,8 +127,3 @@ forms:
     default: true
     description: Handle if the Nozzle logs will be ignored and not send to Sumo Logic
     configurable: false
-  - name: verbose-log-messages
-    type: boolean
-    label: Verbose in LogMessage event
-    default: true
-    description: If is false, it will send only the LogMessage and the App id