diff --git a/README.md b/README.md index ba9c1e6..7c1e704 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ -# DO NOT USE THIS PROJECT. I'M ONLY PLAYING AROUND (FOR NOW) +# Docker Flow Monitor +[![GitHub release](https://img.shields.io/github/release/vfarcic/docker-flow-monitor.svg)]() +[![license](https://img.shields.io/github/license/vfarcic/docker-flow-monitor.svg)]() +[![Docker Pulls](https://img.shields.io/docker/pulls/vfarcic/docker-flow-monitor.svg)]() + +The goal of the *Docker Flow Monitor* project is to provide an easy way to reconfigure Prometheus every time a new service is deployed, or when a service is updated. It does not try to "reinvent the wheel", but to leverage the existing leaders and combine them through an easy to use integration. It uses [Prometheus](https://prometheus.io/) as a metrics storage and query engine and adds custom logic that allows on-demand reconfiguration. + +Please visit the [tutorial](http://monitor.dockerflow.com/tutorial) for a brief introduction or [Configuring Docker Flow Monitor](http://monitor.dockerflow.com/config) and [Usage](http://monitor.dockerflow.com/usage) sections for more details. + +Please join the #df-monitor Slack channel in [DevOps20](http://slack.devops20toolkit.com/) if you have any questions, suggestions, or problems. + +Buy Me a Coffee at ko-fi.com diff --git a/docs/index.md b/docs/index.md index 5838b6e..f12ab2d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,6 +8,6 @@ The goal of the *Docker Flow Monitor* project is to provide an easy way to recon Please visit the [tutorial](/tutorial) for a brief introduction or [Configuring Docker Flow Monitor](/config) and [Usage](/usage) sections for more details. -Please join the #df-proxy Slack channel in [DevOps20](http://slack.devops20toolkit.com/) if you have any questions, suggestions, or problems. +Please join the #df-monitor Slack channel in [DevOps20](http://slack.devops20toolkit.com/) if you have any questions, suggestions, or problems. Buy Me a Coffee at ko-fi.com