add README

README.md

+# IML Appmonitor Dashboard #
+
+Demo Dashboard for IML Appmonitor using the API to fetch data.
+It works offline without a webserver using the Javascript fetch() function.
+
+The Dashboards reds the tags from the IML appmonitor and shows the application status of matching apps.
+
+Author: Axel Hahn; Institute for Medical Education; University of Bern
+
+📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/appmonitor-dashboard/> \
+📜 License: GNU GPL 3.0 \
+
+## Requirements ##
+
+* a running IML Appmonitor instance
+* Appmonitor API must allow access from your ip address in its config (api -> sourceips)
+* Your application checks use tags
+
+## Installation ##
+
+Extract the archive (or use git pull).
+
+We need to setup the url for the api of the IML Appmonitor instance. In `public_html/javascript` copy the dist file inc_config.js.dist to inc_config.js
+
+Replace values in AM_SERVER_URL and AM_TAGS with your real data:
+
+```js
+const AM_SERVER_URL='https://appmonitor.example.com/api';
+const AM_TAGS='live,myapp';
+const REFRESHTIME=30; // in sec
+```
+
+Open the file `public_html/index.html` in your webbrowser.
+
+## Troubleshooting ##
+
+* "no response" error \
+  --> your ip address is not whitelisted in the appmonitor api config.
+* Error 404 \
+  --> no application matches the given tag or tag combination.
+
+## Screenshot ##
+
+![Screenshot](docs/images/screenshot_main.png "Screenshot")
\ No newline at end of file