]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - README.md
Globally #undef min and max on Windows
[user/henk/code/inspircd.git] / README.md
index d3da93347739ce980121d3d67a1b6c1b5cf0162c..89524e7e7b52343af09f581b5922ac40bb09fcd2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,28 @@
-### InspIRCd
+### Important Notice
 
-InspIRCd is an IRC daemon written entirely from scratch, it is one of the  
-few IRC daemons to be written in C++ and it was released under the GNU  
-General Public License. InspIRCd is the second most used IRC daemon  
-according to the ranking on SearchIRC.  
+The `master` branch contains the latest development version. If you are running
+a server then you probably want the `insp20` branch. You can obtain this from
+the [releases](https://github.com/inspircd/inspircd/releases) page or by running
+`git checkout insp20` if you are installing via Git.
 
-The first stable release of InspIRCd was in 2002.
+### About
+
+InspIRCd is a modular Internet Relay Chat (IRC) server written in C++ for Linux,
+BSD, Windows and Mac OS X systems which was created from scratch to be stable,
+modern and lightweight.
+
+As InspIRCd is one of the few IRC servers written from scratch, it avoids a
+number of design flaws and performance issues that plague other more established
+projects, such as UnrealIRCd, while providing the same level of feature parity.
+
+InspIRCd is one of only a few IRC servers to provide a tunable number of
+features through the use of an advanced but well documented module system. By
+keeping core functionality to a minimum we hope to increase the stability,
+security and speed of InspIRCd while also making it customisable to the needs of
+many different users.
 
 ### Links
 
-Website: http://www.inspircd.org  
-GitHub: https://github.com/inspircd/inspircd  
\ No newline at end of file
+* [Website](http://inspircd.org)
+* [GitHub](https://github.com/inspircd)
+* [IRC](irc://irc.chatspike.net/inspircd)
\ No newline at end of file