From e1b464b4d90f102e7a407bd906c418e11990a8ae Mon Sep 17 00:00:00 2001
From: Aleksandar Stojanov <me@fnd.works>
Date: Sun, 10 Dec 2023 14:02:05 +0100
Subject: [PATCH] fix readme.md

---
 README.md      |  5 +++--
 docs/README.md | 13 +++++++++++++
 2 files changed, 16 insertions(+), 2 deletions(-)
 create mode 100644 docs/README.md

diff --git a/README.md b/README.md
index 9e84fc5..4e54c95 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@
 
 Helm plugin for generating `values.schema.json` from single or multiple values files. Works only with Helm3 charts.
 
-## Install
+## Installation
 
 ```bash
 $ helm plugin install https://github.com/losisin/helm-values-schema-json.git
@@ -20,7 +20,8 @@ Installed plugin: schema
 
 - Add multiple values files and merge them together - required
 - Save output with custom name and location - default is values.schema.json in current working directory
-- Change schema draft version - default is draft 2020-12
+- Use preferred schema draft version - default is draft 2020
+- Read annotations from comments. See [docs](https://github.com/losisin/helm-values-schema-json/tree/main/docs) for more info or checkout example yaml files in [testdata](https://github.com/losisin/helm-values-schema-json/tree/main/testdata).
 
 ## Integrations
 
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..c0d27bd
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,13 @@
+# Annotations from comments
+
+JSON schema is partially implemented in this tool. It uses line comments to add annotations for the schema because head comments are frequently used by humans and tools like helm-docs. The following annotations are supported:
+* [Validation Keywords for Any Instance Type](#strings)
+* [Numbers](#numbers)
+* [Booleans](#booleans)
+* [Arrays](#arrays)
+* [Objects](#objects)
+* [Nulls](#nulls)
+* [Required](#required)
+* [Enum](#enum)
+
+## Validation Keywords for Any Instance Type