diff --git a/README.md b/README.md index 081d1a9..82d3f46 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,10 @@ # Rationale The alert handler serve as central component for building reactive self-healing systems, based on Prometheus. - It is meant to be a single binary, which will be distribued and installed to all nodes of clusters. -The routing itself is delegated to alertmanager of prometheus. +The routing itself is delegated to alertmanager of Prometheus. It is main functionality is to `selfheal` and handle Prometheus alerts automatically, which are fired by Prometheus. +The alert-handler share a common declarative API with the alertmanager (based on labels) which need to be respected by users. See [API](doc/api.md) # Devel