Merge pull request #6532 from Icinga/feature/allow-down-times-to-apply-on-child-hosts...

[icinga2] / README.md

diff --git a/README.md b/README.md
index 760ced0298ca413ed8d100ce555e359635fe8035..595af36fe875dad47ec02ad7c3940f01b175b0e4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,18 @@
+[![Build Status](https://travis-ci.org/Icinga/icinga2.svg?branch=master)](https://travis-ci.org/Icinga/icinga2)
+
 # Icinga 2
 
+![Icinga Logo](https://www.icinga.com/wp-content/uploads/2014/06/icinga_logo.png)
+
+#### Table of Contents
+
+1. [About][About]
+2. [License][License]
+3. [Installation][Installation]
+4. [Documentation][Documentation]
+5. [Support][Support]
+6. [Contributing][Contributing]
+
 ## About
 
 Icinga 2 is an open source monitoring system which checks the availability of your
@@ -8,19 +21,59 @@ network resources, notifies users of outages, and generates performance data for
 Scalable and extensible, Icinga 2 can monitor large, complex environments across
 multiple locations.
 
-More details online at [www.icinga.org](https://www.icinga.org/icinga/icinga-2/)
-and inside the [documentation](doc/1-about.md).
+Icinga 2 as monitoring core works best with [Icinga Web 2](https://www.icinga.com/products/icinga-web-2/)
+as web interface.
+
+More information can be found at [www.icinga.com](https://www.icinga.com/products/icinga-2/)
+and inside the [documentation](https://www.icinga.com/docs/icinga2/latest/).
+
+## Licensing
+
+Icinga 2 and the Icinga 2 documentation are licensed under the terms of the GNU
+General Public License Version 2, you will find a copy of this license in the
+COPYING file included in the source package.
+
+In addition, as a special exception, the copyright holders give
+permission to link the code of portions of this program with the
+OpenSSL library under certain conditions as described in each
+individual source file, and distribute linked combinations including
+the two.
+
+You must obey the GNU General Public License in all respects for all
+of the code used other than OpenSSL. If you modify file(s) with this
+exception, you may extend this exception to your version of the
+file(s), but you are not obligated to do so. If you do not wish to do
+so, delete this exception statement from your version. If you delete
+this exception statement from all source files in the program, then
+also delete it here.
 
 ## Installation
 
-Read the [INSTALL.md] file for more information about how to install it.
+Read the [INSTALL.md](INSTALL.md) file for more information about how to install it.
 
 ## Documentation
 
-The documentation is located in the [doc/] directory. The latest documentation
-is also available on https://docs.icinga.org
+The documentation is located in the [doc/](doc/) directory. The latest documentation
+is also available on https://docs.icinga.com
 
 ## Support
 
-Check the project website at https://www.icinga.org for status updates and
-https://support.icinga.org if you want to contact us.
+Check the project website at https://www.icinga.com for status updates. Join the
+[community channels](https://www.icinga.com/community) for questions
+or ask an Icinga partner for [professional support](https://www.icinga.com/services/support/).
+
+## Contributing
+
+There are many ways to contribute to Icinga -- whether it be sending patches,
+testing, reporting bugs, or reviewing and updating the documentation. Every
+contribution is appreciated!
+
+Please continue reading in the [contributing chapter](CONTRIBUTING.md).
+
+<!-- TOC URLs -->
+[About]: #about
+[License]: #license
+[Installation]: #installation
+[Documentation]: #documentation
+[Support]: #support
+[Contributing]: #contributing