Updated readme to show the use of custom templates

brittonhayes · Feb 7, 2021 · 2b35e86 · 2b35e86
1 parent 63a08a6
commit 2b35e86
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -82,6 +82,30 @@ regex = '''(?i)([A-Za-z0-9!#$%&'*+\/=?^_{|.}~-]+@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9
 tags = ["email", "User Info"]
 ```
 
+### Custom Templates
+
+Pillager allows you to use powerful `go text/template` to customize the output format. Here are a few template examples.
+
+#### Basic
+```gotemplate
+{{/*basic.tmpl*/}}
+{{ range .Leaks}}
+    Leak: {{.Line}}
+    Line: {{.LineNumber}}
+    File: {{ .File }}
+{{end}}
+```
+
+#### Markdown Styling
+```gotemplate
+{{/*markdown.tmpl*/}}
+# Results
+{{ range .Leaks}}
+    ## {{ .File }}
+    - Location: {{.LineNumber}}
+{{end}}
+```
+
 ## Documentation
 
 :books: [View the docs](hunter)

diff --git a/templates/markdown.tmpl b/templates/markdown.tmpl
@@ -0,0 +1,6 @@
+{{/*markdown.tmpl*/}}
+# Results
+{{ range .Leaks}}
+    ## {{ .File }}
+    - Location: {{.LineNumber}}
+{{end}}