From 2b6450d671681af3df86ae496b399edbc44415ed Mon Sep 17 00:00:00 2001
From: daniel_sagi <daniel.sagi@aquasec.com>
Date: Wed, 8 Aug 2018 16:04:05 +0300
Subject: [PATCH] added explanation in readme

---
 src/README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/README.md b/src/README.md
index fe78bd7..8a1ce17 100644
--- a/src/README.md
+++ b/src/README.md
@@ -31,6 +31,9 @@ Example:
 ~~~python  
 @handler.subscribe(OpenPortEvent, predicate=lambda event: event.port == 30000)  
 class KubeDashboardDiscovery(Hunter):  
+    """Dashboard Discovery
+    Explanation about what the hunter does
+    """
     def __init__(self, event):  
         self.event = event  
     def execute(self):  
@@ -38,6 +41,8 @@ class KubeDashboardDiscovery(Hunter):
 ~~~  
 Kube Hunter's core module triggers your Hunter when the event you have subscribed it to occurs. 
 in this example, we subscribe the Hunter, `KubeDashboardDiscovery`, to an `OpenPortEvent`, with a predicate that checks the open port (of the event) is 30000.    
+`Convention:` The first line of the comment describing the hunter is the visible name, the other lines are the explanation.
+
    
 ##### ActiveHunter  
 An ActiveHunter will be subscribed to events (and therefore operate) only if KubeHunter is running in active scanning mode.