summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..33de964
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# Icinga Business Process Modeling
+
+[![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-businessprocess/workflows/PHP%20Tests/badge.svg?branch=master)
+[![Github Tag](https://img.shields.io/github/tag/Icinga/icingaweb2-module-businessprocess.svg)](https://github.com/Icinga/icingaweb2-module-businessprocess)
+
+![Icinga Logo](https://icinga.com/wp-content/uploads/2014/06/icinga_logo.png)
+
+If you want to visualize and monitor hierarchical business processes based on
+any or all objects monitored by Icinga, the Icinga Web 2 business process
+module is the way to go.
+
+![Preview](doc/screenshot/00_preview/0005_readme-preview.png)
+
+Want to create custom process-based dashboards? Trigger notifications at
+process or sub-process level? Provide a quick top-level view for thousands of
+components on a single screen? That's what this module has been designed for!
+
+You're running a huge cloud, want to get rid of the monitoring noise triggered
+by your auto-scaling platform but still want to have detailed information just
+a couple of clicks away in case you need them? You will love this little module!
+
+Documentation
+-------------
+
+### Basics
+* [Installation](doc/02-Installation.md)
+* [Getting Started](doc/03-Getting-Started.md)
+* [Create your first process node](doc/04-Create-your-first-process-node.md)
+* [Importing Processes](doc/05-Importing-Processes.md)
+* [Customize Node Order](doc/06-Customize-Node-Order.md)
+* [State Overrides](doc/07-State-Overrides.md)
+* [Operators](doc/09-Operators.md)
+* [Controlling Access](doc/31-Permissions.md)
+
+### Web Components
+* [Breadcrumb](doc/12-Web-Components-Breadcrumb.md)
+* [Tile Renderer](doc/13-Web-Components-Tile-Renderer.md)
+* [Tree Renderer](doc/14-Web-Components-Tree-Renderer.md)
+* [Show Processes on a Dashboard](doc/16-Add-To-Dashboard.md)
+
+### Storage
+* [Store your Configuration](doc/21-Store-Config.md)
+* [Upload an existing Configuration](doc/22-Upload-Config.md)
+
+### The Project
+* [Project History](doc/81-History.md)