From 652c4609092bb7f92780657ca2cd7e013202545d Mon Sep 17 00:00:00 2001 From: Dominic Ricottone Date: Sat, 11 Nov 2023 20:45:10 -0600 Subject: [PATCH] Added README --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6077d90 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Simple Chat + +A simple chat server. + +The only state for this server is the pooled connections. +Messages are not read or logged. +Completely agnostic to encrypted messages. + + +## Usage + +Go to [www.dominic-ricottone.com/chat](https://www.dominic-ricottone.com/chat/) +to see it in action. + +If trying to re-use and deploy this code, first change the hardcoded address in +`server/main.go` (line 103). Then try: + +``` +make server +``` + +This binary listens on port 8080 exposes a websocket, +which needs to be interfaced by a separate client. +See the `clients` directory for some ideas. + + +## Change Log + + + v1.0.1 - Updated dependencies + + v1.0.0 - The imaginary tag, referring to all that came before tags + + +## License + +I share the contents of this repository under the GPL 3 license. + -- 2.45.2