doc: add how to examples in readme

Tahinli · Nov 18, 2023 · b4ab4e2 · b4ab4e2
1 parent e1e94ed
commit b4ab4e2
Showing 1 changed file with 15 additions and 0 deletions.
diff --git 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)