Merge pull request #7483 from Icinga/bugfix/jsonrpc-boost-asio-coroutine-exceptions

[icinga2] / README.md

diff --git a/README.md b/README.md
index 1935d12d452ae9eb9b3020c687a22d89e1e58fd0..1f0f5de8498992126d3f640770e5744122e2670d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,27 +8,45 @@
 #### Table of Contents
 
 1. [About][About]
-2. [License][License]
-3. [Installation][Installation]
-4. [Documentation][Documentation]
-5. [Support][Support]
+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.
 
-Icinga 2 as monitoring core works best with [Icinga Web 2](https://icinga.com/products/icinga-web-2/)
-as web interface.
+Icinga 2 as core requires [Icinga Web 2](https://icinga.com/products/icinga-web-2/)
+on top in your Icinga Stack.
 
-More information can be found at [icinga.com](https://icinga.com/products/icinga-2/)
-and inside the [documentation](https://icinga.com/docs/icinga2/latest/).
+![Icinga Dashboard](https://icinga.com/wp-content/uploads/2017/12/icingaweb2-2.5.0-dashboard.png)
 
-## Licensing
+## Installation
+
+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 available on [icinga.com/docs](https://icinga.com/docs/icinga2/latest/).
+
+## Support
+
+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
@@ -48,21 +66,6 @@ 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](INSTALL.md) file for more information about how to install it.
-
-## Documentation
-
-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://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/services/support/).
-
 ## Contributing
 
 There are many ways to contribute to Icinga -- whether it be sending patches,
@@ -71,6 +74,10 @@ 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