From 239d2c0b3571cc0251a0039ac596714db5a0334d Mon Sep 17 00:00:00 2001
From: Adrian Schmidt <adrian.schmidt@lime.tech>
Date: Tue, 5 May 2020 09:50:47 +0200
Subject: [PATCH] docs(readme.md): update documentation for `types` config

Remove example from default values section, and add a separate
example with description.
---
 README.md | 28 +++++++++++++++++++---------
 1 file changed, 19 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 6e9b91f8..71282a61 100644
--- a/README.md
+++ b/README.md
@@ -26,14 +26,7 @@ Like commitizen, you specify the configuration of cz-conventional-changelog thro
             "defaultSubject": "",
             "defaultBody": "",
             "defaultIssues": "",
-            "types": {
-              ...
-              "feat": {
-                "description": "A new feature",
-                "title": "Features"
-              },
-              ...
-            },
+            "types": null,
             "additionalTypes": {}
         }
     }
@@ -41,7 +34,24 @@ Like commitizen, you specify the configuration of cz-conventional-changelog thro
 }
 ```
 
-The `additionalTypes` property can be used to add custom types in addition to those defined by **conventional-commit-types**:
+The `types` property can be used to *replace* the types defined by **conventional-commit-types**:
+
+```json5
+    "config": {
+        "commitizen": {
+            "types": {
+                ...
+                "feat": {
+                    "description": "A new feature",
+                    "title": "Features"
+                },
+                ...
+            }
+        }
+    }
+```
+
+The `additionalTypes` property can be used to add custom types in *addition to* those defined by **conventional-commit-types**:
 
 ```json5
     "config": {