From 326be81d901d66b7c5a597254e08a6b64c662cee Mon Sep 17 00:00:00 2001
From: CrazyMax <crazy-max@users.noreply.github.com>
Date: Tue, 28 Jan 2020 21:10:15 +0100
Subject: [PATCH] Update doc

---
 README.md               |  4 +---
 doc/configuration.md    | 22 +++++++++++++++++-----
 doc/providers/docker.md |  2 +-
 doc/providers/swarm.md  |  2 +-
 4 files changed, 20 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 3db4f0cb..5719c886 100644
--- a/README.md
+++ b/README.md
@@ -26,9 +26,7 @@
 * Worker pool to parallelize analyses
 * Allow overriding image os and architecture
 * Multi providers available like [Docker](doc/providers/docker.md), [Swarm](doc/providers/swarm.md), [Static](doc/providers/static.md)...
-* Beautiful email report
-* Webhook notification
-* Slack incoming webhook notification
+* Get notified through Slack, Mail, Telegram and [more](doc/notifications.md)
 * Enhanced logging
 * Timezone can be changed
 * Official [Docker image available](doc/install/docker.md)
diff --git a/doc/configuration.md b/doc/configuration.md
index 147b35cb..a093252d 100644
--- a/doc/configuration.md
+++ b/doc/configuration.md
@@ -1,5 +1,15 @@
 # Configuration
 
+* [Overview](#overview)
+* [Reference](#reference)
+  * [db](#db)
+  * [watch](#watch)
+  * [notif](#notif)
+  * [regopts](#regopts)
+  * [providers](#providers)
+
+## Overview
+
 Here is a YAML structure example:
 
 ```yml
@@ -93,17 +103,19 @@ providers:
       arch: arm64v8
 ```
 
-## db
+## Reference
+
+### db
 
 * `path`: Path to Bolt database file where images manifests are stored (default: `diun.db`). Environment var `DIUN_DB` override this value.
 
-## watch
+### watch
 
 * `workers`: Maximum number of workers that will execute tasks concurrently. _Optional_. (default: `10`).
 * `schedule`: [CRON expression](https://godoc.org/github.com/robfig/cron#hdr-CRON_Expression_Format) to schedule Diun watcher. _Optional_. (default: `0 * * * *`).
 * `first_check_notif`: Send notification at the very first analysis of an image. _Optional_. (default: `false`).
 
-## notif
+### notif
 
 * `mail`
   * `enable`: Enable email reports (default: `false`).
@@ -134,7 +146,7 @@ providers:
   * `headers`: Map of additional headers to be sent.
   * `timeout`: Timeout specifies a time limit for the request to be made. (default: `10`).
 
-## regopts
+### regopts
 
 * `username`: Registry username.
 * `username_file`: Use content of secret file as registry username if `username` not defined.
@@ -143,7 +155,7 @@ providers:
 * `timeout`: Timeout is the maximum amount of time for the TCP connection to establish. 0 means no timeout (default: `10`).
 * `insecure_tls`: Allow contacting docker registry over HTTP, or HTTPS with failed TLS verification (default: `false`).
 
-## providers
+### providers
 
 * `docker`: Map of Docker standalone engines to watch
   * `<key>`: An unique identifier for this provider.
diff --git a/doc/providers/docker.md b/doc/providers/docker.md
index 2628db93..4cf93248 100644
--- a/doc/providers/docker.md
+++ b/doc/providers/docker.md
@@ -6,7 +6,7 @@
 
 ## About
 
-The Docker provider allows you to analyze the containers of your standalone Docker instance defined in the [Diun configuration](../configuration.md) to extract the images found and check for updates on the registry.
+The Docker provider allows you to analyze the containers of your standalone Docker instance defined in the [Diun configuration](../configuration.md#providers) to extract the images found and check for updates on the registry.
 
 ## Quick start
 
diff --git a/doc/providers/swarm.md b/doc/providers/swarm.md
index 201b5d01..b5fd8092 100644
--- a/doc/providers/swarm.md
+++ b/doc/providers/swarm.md
@@ -6,7 +6,7 @@
 
 ## About
 
-The Swarm provider is closely linked to the [Docker provider](docker.md) except that it allows you to analyze the services of your Swarm cluster defined in the [Diun configuration](../configuration.md) to extract the images found and check for updates on the registry.
+The Swarm provider is closely linked to the [Docker provider](docker.md) except that it allows you to analyze the services of your Swarm cluster defined in the [Diun configuration](../configuration.md#providers) to extract the images found and check for updates on the registry.
 
 ## Quick start