summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c2413f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Icinga Reporting
+
+[![PHP Support](https://img.shields.io/badge/php-%3E%3D%207.0-777BB4?logo=PHP)](https://php.net/)
+![Build Status](https://github.com/icinga/icingaweb2-module-reporting/workflows/PHP%20Tests/badge.svg?branch=master)
+[![Github Tag](https://img.shields.io/github/tag/Icinga/icingaweb2-module-reporting.svg)](https://github.com/Icinga/icingaweb2-module-reporting)
+
+![Icinga Logo](https://icinga.com/wp-content/uploads/2014/06/icinga_logo.png)
+
+Icinga Reporting is the central component for reporting related functionality in the monitoring web frontend and
+framework Icinga Web 2. The engine allows you to create reports over a specified time period for ad-hoc and scheduled
+generation of reports. Other modules use the provided functionality in order to provide concrete reports.
+
+If you are looking for SLA reports for your hosts and services, please also install the
+[idoreports](https://github.com/Icinga/icingaweb2-module-idoreports) module.
+
+## Documentation
+
+* [Installation](doc/02-Installation.md)