X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=README;h=87824263e449cc109f01eb4058f9839437942d8d;hb=ad68cf29f652c5bfa7822a10000e9da658fbf1d5;hp=faae872a565d47817ed544d6c7e09ace15a89472;hpb=b35f6e7b3c510bea24c0927073720a459055816e;p=goircd.git diff --git a/README b/README index faae872..8782426 100644 --- a/README +++ b/README @@ -1,10 +1,6 @@ goircd -- minimalistic simple Internet Relay Chat (IRC) server ============================================================== -SYNOPSIS - -goircd is very simple IRC server, written on Go. - DESCRIPTION goircd is very simple IRC server, written on Go. @@ -14,7 +10,6 @@ It does not aim to replace full featured mass scalable IRC networks: * It can not connect to other servers. Just standalone installation * It has few basic IRC commands * There is no support for channel operators, modes, votes, invites - and so on * No ident lookups, reverse DNS queries But it has some convincing features: @@ -28,7 +23,7 @@ But it has some convincing features: * Optional permanent channel's state saving in plain text files (so you can reload daemon and all channels topics and keys won't disappear) -* Optional ability to authenticate users by nickname↔password +* Optional ability to authenticate users by nickname and password Some remarks and recommendations related to it's simplicity: @@ -40,7 +35,7 @@ SUPPORTED IRC COMMANDS * PASS/NICK/USER during registration workflow * PING/PONGs * NOTICE/PRIVMSG -* MOTD, LUSERS, WHO, WHOIS, VERSION, QUIT +* AWAY, MOTD, LUSERS, WHO, WHOIS, VERSION, QUIT * LIST, JOIN, TOPIC, +k/-k channel MODE USAGE @@ -56,8 +51,8 @@ Just execute goircd daemon. It has following optional arguments: * -statedir: directory where all channels states will be saved and loaded during startup. If omitted, then states will be lost after daemon termination -* -tlsbind/-tlskey/-tlscert: enable TLS, specify address to listen on, - certificate and key files +* -tlsbind/-pem: enable TLS, specify address to listen on and path + to PEM file with certificate and private key * -passwords: enable client authentication and specify path to passwords file * -verbose: increase log messages verbosity