Mention TLS and -verbose options in documentation

[goircd.git] / README

diff --git a/README b/README
index b0082f02dcb8a943d6a2a802fea190a7b484d3e1..03f31d88485e3ad1b1af0c04d05951c3c0731459 100644 (file)
--- a/README
+++ b/README
@@ -7,12 +7,13 @@ 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
+* There is no support for channel operators, modes, votes, invites
   and so on
 * No ident lookups, reverse DNS queries
 
@@ -22,6 +23,7 @@ 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
@@ -30,7 +32,6 @@ But it has some convincing features:
 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
@@ -54,6 +55,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
+* -tls_key/-tls_cert: enable TLS and specify key and certificate file
+* -verbose: increase log messages verbosity
 
 LICENCE