]> granicus.if.org Git - icinga2/blobdiff - README.md
Update default cipher_list in upgrading docs
[icinga2] / README.md
index c81586b39fbd22dfe0fdcd6cc08174400899b02c..1f0f5de8498992126d3f640770e5744122e2670d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,25 +1,87 @@
+[![Build Status](https://travis-ci.org/Icinga/icinga2.svg?branch=master)](https://travis-ci.org/Icinga/icinga2)
+[![Github Tag](https://img.shields.io/github/tag/Icinga/icinga2.svg)](https://github.com/Icinga/icinga2)
+
 # Icinga 2
 
+![Icinga Logo](https://icinga.com/wp-content/uploads/2014/06/icinga_logo.png)
+
+#### Table of Contents
+
+1. [About][About]
+2. [Installation][Installation]
+3. [Documentation][Documentation]
+4. [Support][Support]
+5. [License][License]
+6. [Contributing][Contributing]
+
 ## About
 
-Icinga 2 is an open source monitoring system which checks the availability of your
-network resources, notifies users of outages, and generates performance data for reporting.
+[Icinga 2](https://icinga.com/products/icinga-2/) is a monitoring system which checks
+the availability of your network resources, notifies users of outages, and generates
+performance data for reporting.
 
 Scalable and extensible, Icinga 2 can monitor large, complex environments across
 multiple locations.
 
-Check doc/1-about.md for a detailed introduction.
+Icinga 2 as core requires [Icinga Web 2](https://icinga.com/products/icinga-web-2/)
+on top in your Icinga Stack.
+
+![Icinga Dashboard](https://icinga.com/wp-content/uploads/2017/12/icingaweb2-2.5.0-dashboard.png)
 
 ## Installation
 
-Read the INSTALL file for more information about how to install it.
+For installing Icinga please check the [installation chapter](https://icinga.com/docs/icinga2/latest/doc/02-getting-started/)
+in the documentation.
+
+If you are a packager, please read the [development chapter](https://icinga.com/docs/icinga2/latest/doc/21-development/)
+for more details.
 
 ## Documentation
 
-The documentation is located in the doc/ directory. The latest documentation
-is also available on https://docs.icinga.org
+The documentation is available on [icinga.com/docs](https://icinga.com/docs/icinga2/latest/).
 
 ## Support
 
-Check the project website at http://www.icinga.org for status updates and
-https://support.icinga.org if you want to contact us.
+Check the [project website](https://icinga.com) for status updates. Join the
+[community channels](https://icinga.com/community/) for questions
+or ask an Icinga partner for [professional support](https://icinga.com/support/).
+
+## License
+
+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.
+
+## 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).
+
+### Security Issues
+
+For reporting security issues please visit [this page](https://icinga.com/contact/security/).
+
+<!-- TOC URLs -->
+[About]: #about
+[License]: #license
+[Installation]: #installation
+[Documentation]: #documentation
+[Support]: #support
+[Contributing]: #contributing