X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=README;h=87824263e449cc109f01eb4058f9839437942d8d;hb=e9a315574b96c6a235c9d55e607c3b4526eedf2f;hp=b0082f02dcb8a943d6a2a802fea190a7b484d3e1;hpb=b2f90fb412218973608b24a32eebadc60de9878a;p=goircd.git

diff --git a/README b/README
index b0082f0..8782426 100644
--- a/README
+++ b/README
@@ -1,19 +1,15 @@
      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.
 It is heavily inspired by miniircd daemon written on Python.
-It is not aimed to replace full featured mass scalable IRC networks:
+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 not support for channel operators, modes, votes, invites
-  and so on
+* There is no support for channel operators, modes, votes, invites
 * No ident lookups, reverse DNS queries
 
 But it has some convincing features:
@@ -22,23 +18,24 @@ But it has some convincing features:
 * Single executable binary
 * No configuration file, just few command line arguments
 * IPv6 out-of-box support
+* Ability to listen on TLS-capable ports
 * Optional channel logging to plain text files
 * 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 and password
 
 Some remarks and recommendations related to it's simplicity:
 
 * Use either nohup or similar tools to daemonize it
-* Use either crywrap or similar tools for TLS-capable connections
 * Just plain logging on stderr, without syslog support
 
 SUPPORTED IRC COMMANDS
 
-* NICK/USER during registration workflow
+* PASS/NICK/USER during registration workflow
 * PING/PONGs
 * NOTICE/PRIVMSG
-* MOTD, LUSERS, WHO, WHOIS, QUIT
+* AWAY, MOTD, LUSERS, WHO, WHOIS, VERSION, QUIT
 * LIST, JOIN, TOPIC, +k/-k channel MODE
 
 USAGE
@@ -54,6 +51,29 @@ 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/-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
+
+TLS
+
+If you specify -bind and -tlsbind simultaneously, then you will have
+both raw and encrypted listening sockets. You can use -bind "" to
+disable raw socket.
+
+AUTHENTICATION
+
+You can turn on optional client authentication by preparing passwords
+file and using the -passwords argument. Format of passwords file is:
+
+    login1:password1\n
+    login2:password2\n
+    …
+
+You can force rereading of passwords file without server interruption by
+sending HUP signal to him.
 
 LICENCE