aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authormcpcpc <michaelczigler@icloud.com>2020-09-16 23:57:09 -0400
committermcpcpc <michaelczigler@icloud.com>2020-09-16 23:57:09 -0400
commit7587814cdf34c86ec4bb2ee6f080943b72db6863 (patch)
tree812e445db071c719a2f8c976d1ba4fa1f055c4c5 /README.md
parentadd error check for fopen() (diff)
downloadkirc-7587814cdf34c86ec4bb2ee6f080943b72db6863.tar.gz
kirc-7587814cdf34c86ec4bb2ee6f080943b72db6863.tar.bz2
kirc-7587814cdf34c86ec4bb2ee6f080943b72db6863.tar.xz
kirc-7587814cdf34c86ec4bb2ee6f080943b72db6863.tar.zst
kirc-7587814cdf34c86ec4bb2ee6f080943b72db6863.zip
add tls/ssl example
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3e9f185..1a125a6 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,7 @@ usage: kirc [-s hostname] [-p port] [-c channel] [-n nick] [-r real name] [-u us
* No dependencies other than a [C99 compiler](https://gcc.gnu.org/).
* Complies with [RFC 2812](https://tools.ietf.org/html/rfc2812) standard.
* Ability to log the entire chat history (see _Usage_ section for more information).
-- Simple command structure:
+* Simple command structure:
```shell
<message> Send a message to the current channel.
@@ -85,3 +85,19 @@ cd kirc
make
make install
```
+
+## TLS/SSL Support
+
+There is no native TLS/SSL support. Instead, users can achieve this functionality by using third-party tools (e.g. stunnel, socat, ghosttunnel).
+
+* _socat_ example:
+
+```shell
+socat -v tcp-listen:6667,reuseaddr,fork,bind=127.0.0.1 ssl:<irc-server>:669
+kirc -s 127.0.0.1 -c 'channel' -n 'name' -r 'realname'
+```
+
+## Contact
+
+For any further questions or concerns, feel free to reach out to me on `#kirc` or `#kisslinux`.
+