From b4ab4e2f187b406215fe5b2451a0ff3e185f1003 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ahmet=20Kaan=20G=C3=9CM=C3=9C=C5=9E?= <96421894+Tahinli@users.noreply.github.com> Date: Sat, 18 Nov 2023 17:50:39 +0000 Subject: [PATCH] doc: add how to examples in readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 8bf8d1d..d4d0693 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,21 @@ # rust-tcp-file-transfer TCP File Transfer Server and Client in Rust +**Usage** +> ./rust-tcp-file-transfer -h +> +![image](https://github.com/Tahinli/rust-tcp-file-transfer/assets/96421894/7370c9f7-e491-42de-bf81-8f16b8daa248) + +**Examples** +> ./rust-tcp-file-transfer -sv -s -l ~/Desktop/cat.png +> +> ./rust-tcp-file-transfer -cl -r -l ~/Documents/ + + +**TO-DO List** + +☑ Standard library only. + ☑ File transfer over network. ☑ Remove memory limitations. [d42412c](https://github.com/Tahinli/rust-tcp-file-transfer/pull/1/commits/d42412c57d7d95672ba64b3e489b95f1c4b04a08)