From e2bfcbbcfed5eb60f47625066cc7c8503dd52f79 Mon Sep 17 00:00:00 2001 From: tomsucho Date: Thu, 21 Dec 2023 14:21:54 +0100 Subject: [PATCH] [feat] Update README file --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 57e8fcf..d214e30 100644 --- a/README.md +++ b/README.md @@ -1 +1,15 @@ -## This is a Golang code examples repo I used when learning. +## This is a Golang code examples repo I used for learning. + +### TCP Client Server + +- Features: + + - starts a TCP server on port 8080 by default + - prints data the client has sent it + - responds back to client with timestamped text message confirming data reception + - the client currently sends a single hardcoded msg and quits, so quite rudimentary to not say useless, but this is just learning. For more advanced client functionality one could just use telnet or netcat instead of course :) +- Installation: + - go install github.com/tomsucho/go-examples/tcp-client-server/tcp-client@latest + - go install github.com/tomsucho/go-examples/tcp-client-server/tcp-server@latest +- Usage: + - the above will build executable and store it under your `$PATH` so you then you can start each with just typing `tcp-server` or `tcp-client`.