From b31e079256cf072527d9f39441ff4f9410c9623d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Eric=20Janouch?= Date: Sat, 27 Aug 2022 16:17:47 +0200 Subject: [PATCH] Update README --- README.adoc | 34 ++++++++++++++-------------------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/README.adoc b/README.adoc index 9d61d8c..a9e8b08 100644 --- a/README.adoc +++ b/README.adoc @@ -5,27 +5,23 @@ xK daemon, and bot. It's all you're ever going to need for chatting, so long as you can make do with slightly minimalist software. -They come with these potentially interesting properties: - - - supporting IRCv3, SOCKS, IPv6, TLS (including client certificates) - - lean on dependencies - - compact and arguably easy to hack on - - maximally permissive license +They're all lean on dependencies, and offer a maximally permissive licence. xC -- -The IRC client, and the core of 'xK'. It is largely defined by being built -on top of GNU Readline that has been hacked to death. Its interface should feel -somewhat familiar for weechat or irssi users. +The IRC client, and the core of 'xK'. It is largely defined by building on top +of GNU Readline or BSD Editline that have been hacked to death. Its interface +should feel somewhat familiar for weechat or irssi users. image::xC.png[align="center"] -It has most of the stuff you'd expect of an IRC client, such as being -multiserver, a powerful configuration system, integrated help, text formatting, -automatic splitting of overlong messages, multiline editing, bracketed paste -support, decent word wrapping, autocomplete, logging, CTCP queries, auto-away, -command aliases, and basic support for Lua scripting. As a unique bonus, -you can launch a full text editor from within. +It has most features you'd expect of an IRC client, such as being multiserver, +a powerful configuration system, integrated help, text formatting, automatic +message splitting, multiline editing, bracketed paste support, word wrapping +that doesn't break links, autocomplete, logging, CTCP queries, auto-away, +command aliases, SOCKS proxying, SASL EXTERNAL authentication using TLS client +certificates, or basic support for Lua scripting. As a unique bonus, you can +launch a full text editor from within. xD -- @@ -34,11 +30,9 @@ than a system-wide daemon. If all you want is a decent, minimal IRCd for testing purposes or a small network of respectful users (or bots), this one will do it just fine. -Notable features: - - - TLS autodetection (I'm still wondering why everyone doesn't have this) - - IRCop authentication via TLS client certificates - - partial IRCv3 support +It autodetects TLS on incoming connections (I'm still wondering why everyone +doesn't have this), authenticates operators via TLS client certificate +fingerprints, and supports a number of IRCv3 capabilities. Not supported: