diff --git a/README.md b/README.md index 954a203..f29cabe 100755 --- a/README.md +++ b/README.md @@ -1,14 +1,19 @@ # SockTalk SockTalk source code and MakeFile (server and client) + MakeFile may have to be modified to use installed compiler. -SockTalk is a C++ static library. In the `stclient` folder is a command line program that uses the SockTalk protocol. +The SockTalk protocol is a simple, open-source network communication protocol. Communication is encrypted using SSL (currently requires `cert.pem` and `key.pem` to be in +the directory of the executables). + +SockTalk is a C++ static library. In the `stclient` folder is a pair of command line IM programs (server and client) that use the SockTalk protocol. Certificate and key +not provided. Compiling SockTalk requires that the OpenSSL library be installed. Server listens on socket on desired port and multiple clients can connect. -"/close" from server side closes server socket. -"/disconnect" from client side disconnects from server. -"/help" gives a list of commands supported by the server. +- "/close" from server side closes server socket. +- "/disconnect" from client side disconnects from server. +- "/help" gives a list of commands supported by the server. SockTalk client-server registration protocol: 1. Client connects to server via socket @@ -18,9 +23,8 @@ SockTalk client-server registration protocol: 5. If username is unavailable, handler memory is deallocated and connection is refused 6. If username is available, handler gets added to handler list and the connection is established -Source code available under GPLv3. Read LICENSE.txt for more details. +Source code available under GPLv3, except for OpenSSL library. Read LICENSE.txt for more details. Work is based on a project by Matthew Chen and Arc676/Alessandro Vinciguerra. -Source code for that project is available under MIT license here: -https://github.com/Arc676/Java-Chat -Please report if link is broken. + +Source code for that project is available under MIT license [here](https://github.com/Arc676/Java-Chat)