diff --git a/README.md b/README.md index 90ae78d..dbc4744 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ MonDash is a service for everyone having to display monitoring results to people who have not the time or knowledge to get familar with Nagios / Icinga or similar monitoring systems. Therefore -MonDash provides a simple API to submit monitoring results and a simple dashboard to view those -results. +MonDash provides a [simple API](http://docs.mondash.apiary.io/) to submit monitoring results and a +simple dashboard to view those results. ## Hosted @@ -27,4 +27,4 @@ MonDash needs some environment variables set when running: Just some words regarding security: MonDash was designed to be an open platform for creating dashboards without any hazzle. You just open a dashboard, send some data to it and you're already done. No need to think about OAuth or other authentication mechanisms. -The downpath of that concept is of course everyone can access every dashboard and see every data placed on it. So please don't use the public instances for private and/or secret data. You can just set up your own instance within 5 minutes (okay maybe 10 minutes if you want to do it right) and you can ensure that this instance is hidden from the internet. \ No newline at end of file +The downpath of that concept is of course everyone can access every dashboard and see every data placed on it. So please don't use the public instances for private and/or secret data. You can just set up your own instance within 5 minutes (okay maybe 10 minutes if you want to do it right) and you can ensure that this instance is hidden from the internet.