]> arthur.barton.de Git - ngircd-alex.git/blobdiff - README.md
Send NAMES list and channel topic to NJOIN'ed users
[ngircd-alex.git] / README.md
index 144e4072bf777622d498455687e626bf21b15e88..615931861505cf899224a33393f67c0767c7d65c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,11 +7,13 @@ server for small or private networks, developed under the terms of the GNU
 General Public License ([GPL]); please see the file `COPYING` for licensing
 information.
 
-The server is simple to configure, can cope with dynamic IP addresses, and
-supports IPv6 as well as SSL. It is written from scratch and not based on the
-original IRCd.
+The server is quite easy to configure, can handle dynamic IP addresses, and
+optionally supports IDENT, IPv6 connections, SSL-protected links, and PAM for
+user authentication as well as character set conversion for legacy clients. The
+server has been written from scratch and is not based on the "forefather", the
+daemon of the IRCNet.
 
-The name ngIRCd means *next generation IRC daemon*, which is a little bit
+The name ngIRCd means *next-generation IRC daemon*, which is a little bit
 exaggerated: *lightweight Internet Relay Chat server* most probably would have
 been a better name :-)
 
@@ -20,8 +22,9 @@ online available here: <https://ngircd.barton.de/doc/INSTALL.md>!
 
 ## Status
 
-ngIRCd should be quite feature complete and stable to be used as daemon in
-real world IRC networks.
+The development of ngIRCd started back in 2001 and in the meantime it should be
+quite feature-complete and stable to be used as a daemon in real-world IRC
+networks.
 
 It is not the goal of ngIRCd to implement all the nasty behaviors of the
 original ircd, but to implement most of the useful commands and semantics
@@ -39,12 +42,15 @@ specified by the RFCs that are used by existing clients.
 - Freely available, modern, portable and tidy C source.
 - Wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
   IRIX, Linux, macOS, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
-- ngIRCd is being actively developed since 2001.
 
 ## Documentation
 
 The **homepage** of the ngIRCd project is <https://ngircd.barton.de>.
 
+Installation on ngIRCd is described in the file `INSTALL.md` in the source
+directory; please see the file `doc/QuickStart.md` in the `doc/` directory for
+some configuration examples.
+
 More documentation can be found in the `doc/` directory and
 [online](https://ngircd.barton.de/documentation).