From fcdbb403e632f399a10c6748d52f6a8c58bb0707 Mon Sep 17 00:00:00 2001
From: Danny Koppenhagen <Danny.Koppenhagen@deutschebahn.com>
Date: Mon, 17 Jan 2022 19:44:43 +0100
Subject: [PATCH] docs: move `editLink` config into readme

---
 README.md          | 16 +++++++++++++++-
 public/config.json |  6 +-----
 2 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index a055f284..b1aaa4da 100644
--- a/README.md
+++ b/README.md
@@ -110,7 +110,7 @@ To change the logo, create a public folder in your application and put your `log
 
 For reference have a look at [public/logo.svg](./public/logo.svg).
 
-### Change the logo
+### Change the date format
 By default the Date format used in the app is `"MMMM YYYY"`.
 You can change this by editing the config file as shown below.
 Please be sure you are entering a valid [moment.js format string](https://momentjs.com/docs/#/displaying/format).
@@ -124,6 +124,20 @@ Please be sure you are entering a valid [moment.js format string](https://moment
 
 For reference have a look at [public/logo.svg](./public/logo.svg).
 
+### Edit from published radar
+
+You can activate the `editLink` feature which will display a small edit button next to a technology which let's you jump directly to a gitlab / github / etc. edit page:
+
+```json
+{
+  // ...
+  "editLink": {
+    "radarLink": "https://github.com/AOEpeople/techradar/edit/main/radar",
+    "title": "Edit"
+  }
+}
+```
+
 ### Change the rings and quadrants config
 To change the default rings and quadrants of the radar, you can place a custom `config.json` file within the `public` folder.
 The `showEmptyRings` option can be enabled to display the header for a ring even when it contains no items (helpful to
diff --git a/public/config.json b/public/config.json
index 9260e065..fd87d075 100644
--- a/public/config.json
+++ b/public/config.json
@@ -65,9 +65,5 @@
       }
     ]
   },
-  "dateFormat": "MMMM YYYY",
-  "editLink": {
-    "radarLink": "https://github.com/AOEpeople/techradar/edit/main/radar",
-    "title": "Edit"
-  }
+  "dateFormat": "MMMM YYYY"
 }