improve README adding feature list
authorChristophe Romain <christophe.romain@process-one.net>
Mon, 15 Dec 2014 09:26:57 +0000 (10:26 +0100)
committerChristophe Romain <christophe.romain@process-one.net>
Mon, 15 Dec 2014 09:26:57 +0000 (10:26 +0100)
README

diff --git a/README b/README
index c4e166f8630dae23bedaf5f66ff3f0424e04cf7a..b8a706c89e1837876b1fcff9604bb9c70e4b7e74 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,92 @@
-ejabberd - High-Performance Enterprise Instant Messaging Server 
----------------------------------------------------------------
-
-Quickstart guide
-================
+Ejabberd Community Edition, by ProcessOne
+-----------------------------------------
+
+
+ejabberd is a distributed, fault-tolerant technology that allows the creation
+of large-scale instant messaging applications.
+The server can reliably support thousands of simultaneous users on a single
+node and has been designed to provide exceptional standards of fault
+tolerance.
+As an open source technology, based on industry-standards, ejabberd can be
+used to build bespoke solutions very cost effectively.
+
+
+Key Features:
+=============
+
+
+-   Cross-platform: ejabberd runs under Microsoft Windows and Unix derived
+systems such as Linux, FreeBSD and NetBSD.
+-   Distributed: You can run ejabberd on a cluster of machines and all of them
+will serve the same Jabber domain(s). When you need more capacity you can
+simply add a new cheap node to your cluster. Accordingly, you do not need to
+buy an expensive high-end machine to support tens of thousands concurrent
+users.
+-   Fault-tolerant: You can deploy an ejabberd cluster so that all the
+information required for a properly working service will be replicated
+permanently on all nodes. This means that if one of the nodes crashes, the
+others will continue working without disruption. In addition, nodes also can
+be added or replaced ‘on the fly’.
+-   Administrator Friendly: ejabberd is built on top of the Open Source
+Erlang. As a result you do not need to install an external database, an
+external web server, amongst others because everything is already included,
+and ready to run out of the box. Other administrator benefits include: 
+        Comprehensive documentation.
+        Straightforward installers for Linux, Mac OS X.
+        Web Administration.
+        Shared Roster Groups.
+        Command line administration tool.
+        Can integrate with existing authentication mechanisms.
+        Capability to send announce messages._
+-   Internationalized: ejabberd leads in internationalization. Hence it is
+very well suited in a globalized world. Related features are:
+        Translated to 25 languages.
+        Support for IDNA._
+-   Open Standards: ejabberd is the first Open Source Jabber server claiming
+to fully comply to the XMPP standard.
+        Fully XMPP compliant.
+        XML-based protocol.
+        Many protocols supported._
+
+
+Additional Features:
+====================
+
+
+Moreover, ejabberd comes with a wide range of other state-of-the-art features:
+
+-   Modular
+        Load only the modules you want.
+        Extend ejabberd with your own custom modules. 
+-   Security
+        SASL and STARTTLS for c2s and s2s connections.
+        STARTTLS and Dialback s2s connections.
+        Web Admin accessible via HTTPS secure access. 
+-   Databases
+        Internal database for fast deployment (Mnesia).
+        Native MySQL support.
+        Native PostgreSQL support.
+        ODBC data storage support.
+        Microsoft SQL Server support. 
+-   Authentication
+        Internal Authentication.
+        PAM, LDAP and ODBC.
+        External Authentication script. 
+-   Others
+        Support for virtual hosting. 
+        Compressing XML streams with Stream Compression (XEP-0138).
+        Statistics via Statistics Gathering (XEP-0039).
+        IPv6 support both for c2s and s2s connections.
+        Multi-User Chat module with support for clustering and HTML logging.
+        Users Directory based on users vCards.
+        Publish-Subscribe component with support for Personal Eventing.
+        Support for web clients: HTTP Polling and HTTP Binding (BOSH).
+        IRC transport.
+        Component support: interface with networks such as AIM, ICQ and MSN
+
+
+Quickstart guide:
+=================
 
 
 0. Requirements
@@ -56,7 +140,16 @@ start and stop ejabberd. For example:
     ejabberdctl start
 
 
-For detailed information please refer to the [ejabberd Installation and
-Operation Guide][1].
+For detailed information please refer to the ejabberd Installation and
+Operation Guide available online and in the doc directory of sources tarball.
+
+
+Links:
+======
+
+
+Guide: http://www.process-one.net/docs/ejabberd/guide_en.html
+Official site: https://www.process-one.net/en/ejabberd
+Community site: http://www.ejabberd.im
+Forum: http://www.process-one.net/en/forum
 
-[1]: http://www.process-one.net/docs/ejabberd/guide_en.html