From 61be84a086aaa82b80bd64ffa2bea8893be379dc Mon Sep 17 00:00:00 2001
From: Mike Penz <mikepenz@gmail.com>
Date: Thu, 25 May 2023 18:09:38 +0000
Subject: [PATCH] - add optional `key` to README

---
 README.md                  | 2 ++
 configs/configuration.json | 3 ---
 2 files changed, 2 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index b6a9112..a919c36 100644
--- a/README.md
+++ b/README.md
@@ -211,6 +211,7 @@ This configuration is a `JSON` in the following format. (The below showcases *ex
         "labels": ["fix"]
       },
       {
+        "key": "tests",
         "title": "## 🧪 Tests",
         "labels": ["test"]
       },
@@ -419,6 +420,7 @@ Table of descriptions for the `configuration.json` options to configure the resu
 | **Input**                   | **Description**                                                                                                                                                                                                                    |
 |-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | categories                  | An array of `category` specifications, offering a flexible way to group changes into categories.                                                                                                                                   |
+| category.key                | Optional key used for the `categorized` json output.                                                                                                                                                                                    |
 | category.title              | The display name of a category in the changelog.                                                                                                                                                                                   |
 | category.labels             | An array of labels, to match pull request labels against. If any PR label matches any category label, the pull request will show up under this category. (See `exhaustive` to change this)                                         |
 | category.exclude_labels     | Similar to `labels`, an array of labels to match PRs against, but if a match occurs the PR is excluded from this category.                                                                                                         |
diff --git a/configs/configuration.json b/configs/configuration.json
index a1207ac..d220c1f 100644
--- a/configs/configuration.json
+++ b/configs/configuration.json
@@ -1,17 +1,14 @@
 {
     "categories": [
         {
-            "key": "feature",
             "title": "## 🚀 Features",
             "labels": ["feature"]
         },
         {
-            "key": "fixes",
             "title": "## 🐛 Fixes",
             "labels": ["fix"]
         },
         {
-            "key": "tests",
             "title": "## 🧪 Tests",
             "labels": ["test"]
         }