docs: v0.1.2

Author: obaraelijah

CHANGELOG.md

@@ -0,0 +1,18 @@
+## v0.1.2 (21.06.2024)
+
+-   Added ability to provide custom bytes separator via command line argument `--separator`.
+-   Added ability to provide custom timestamp precision of console payload output via command line argument `--precision`.
+-   Removed redundant module path and target from console output.
+-   Bump minimal supported rust version (MSRV) to 1.79.0.
+-   README improvements.
+-   Dependencies updates:
+    -   `bytes` from 1.4.0 to 1.5.0
+    -   `clap` from 4.2.5 to 4.4.7
+    -   `log` from 0.4.17 to 0.4.20
+    -   `logged-stream` from 0.2.5 to 0.3.4
+    -   `tokio` from 1.27.0 to 1.32.0
+    -   Some indirect dependencies.
+
+## v0.1.1 (20.06.2024)
+
+-   README improvements

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "proxy_logger"
-version = "0.1.1"
+version = "0.1.2"
 authors = ["Elijah Samson <elijahobara357@gmail.com>"]
 description = "Command line interface for proxying TCP connections with payload output into console which can be formatted different ways."
 keywords = ["network", "tcp", "proxy", "logging", "debugging"]
@@ -17,7 +17,7 @@ edition = "2021"
 
 [dependencies]
 bytes = "1.6.0"
-clap = { version = "4.5.6", features = ["std", "derive"] }
+clap = { version = "4.5.7", features = ["std", "derive"] }
 env_logger = "0.11.3"
 log = "0.4.21"
 logged-stream = "0.3.5"

Cargo.toml

@@ -47,3 +47,34 @@ Now you can run compiled binary:
 ```sh
 $ proxy_logger --bind-listener-addr 127.0.0.1:20502 --remote-addr 127.0.0.1:20582
 ```
+## Options
+
+Below is a list of currently supported options.
+
+```
+$ proxy_logger --help
+Command line interface for proxying TCP connections with payload output into console which can be formatted different ways.
+
+Usage: proxy_logger [OPTIONS] --bind-listener-addr <BIND_LISTENER_ADDR> --remote-addr <REMOTE_ADDR>
+
+Options:
+  -l, --level <LEVEL>
+          Application logging level [default: debug] [possible values: trace, debug, info, warn, error, off]
+  -b, --bind-listener-addr <BIND_LISTENER_ADDR>
+          Address on which TCP listener should be binded
+  -r, --remote-addr <REMOTE_ADDR>
+          Address of remote server
+  -t, --timeout <TIMEOUT>
+          Incoming connection reading timeout [default: 60]
+  -f, --formatting <FORMATTING>
+          Formatting of console payload output, [default: lowerhex] [possible values: decimal, lowerhex, upperhex, binary, octal]
+  -s, --separator <SEPARATOR>
+          Console payload output bytes separator [default: :]
+  -p, --precision <PRECISION>
+          Timestamp precision [default: seconds] [possible values: seconds, milliseconds, microseconds, nanoseconds]
+  -h, --help
+          Print help
+  -V, --version
+          Print version
+```
+