Update README

This commit is contained in:
Přemysl Eric Janouch 2015-07-15 22:56:34 +02:00
parent d6a4ca1434
commit aa6225496b
1 changed files with 10 additions and 12 deletions

22
README
View File

@ -5,23 +5,21 @@ daemon, and bot. It's all you're ever going to need for chatting.
All of them have these potentially interesting properties: All of them have these potentially interesting properties:
- full IPv6 support - full IPv6 support
- SSL/TLS support, including client certificates - TLS support, including client certificates
- minimal dependencies - minimal dependencies
- very compact and easy to hack on - very compact and easy to hack on
- liberal license - permissive license
degesch degesch
------- -------
The IRC client. It is largely defined by being built on top of GNU Readline. The IRC client. It is largely defined by being built on top of GNU Readline.
Its interface should however feel familiar for weechat or irssi users. Its interface should however feel familiar for weechat or irssi users.
This is the youngest and largest application within the project and it's This is the youngest and largest application within the project. It has most of
currently under development. the stuff you'd expect of an IRC client, such as being able to set up multiple
servers, powerful configuration system, integrated help, mIRC text formatting,
It has most of the stuff you'd expect of an IRC client, such as being able to CTCP queries, automatic splitting of overlong messages, autocomplete, logging
set up multiple servers, powerful configuration system, integrated help, to file, and command aliases.
mIRC text formatting, CTCP queries, automatic splitting of overlong messages,
autocomplete, file logging, and command aliases.
kike kike
---- ----
@ -30,8 +28,8 @@ than a system-wide daemon. If all you want is a decent, minimal IRCd for
a small network of respectful users (or bots), or testing, this one will do it. a small network of respectful users (or bots), or testing, this one will do it.
Notable features: Notable features:
- SSL/TLS autodetection (why doesn't everyone have this?) - TLS autodetection (why doesn't everyone have this?)
- IRCop authentication through SSL/TLS client certificates - IRCop authentication through TLS client certificates
- epoll support on Linux; it should be able to handle quite a number of users - epoll support on Linux; it should be able to handle quite a number of users
- partial IRCv3 support - partial IRCv3 support
@ -103,7 +101,7 @@ as a `forking' type systemd user service.
Client Certificates Client Certificates
------------------- -------------------
`kike' uses SHA1 fingerprints of SSL client certificates to authenticate users. `kike' uses SHA1 fingerprints of TLS client certificates to authenticate users.
To get the fingerprint from a certificate file in the required form, use: To get the fingerprint from a certificate file in the required form, use:
$ openssl x509 -in public.pem -outform DER | sha1sum $ openssl x509 -in public.pem -outform DER | sha1sum