feat: create README.md (#3)

jjoshm · Sep 13, 2021 · 0161612 · 0161612
1 parent 59fc044
commit 0161612
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# knockson
+simple multi-threaded port scanner written in rust
+
+# Usage
+```USAGE:
+    knockson [OPTIONS]
+
+FLAGS:
+        --help       Print help information
+    -V, --version    Print version information
+
+OPTIONS:
+    -a, --amount-thread <AMOUNT_THREAD>    [default: 10]
+    -f, --from-port <FROM_PORT>            [default: 1]
+    -h, --host <HOST>                      [default: 127.0.0.1]
+    -t, --to-port <TO_PORT>                [default: 65535]
+```
+
+## Example
+`knockson -f 1 -t 200 -h scanme.nmap.org -a 100`