Skip to content

Commit

Permalink
fix readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
losisin committed Dec 10, 2023
1 parent c606b57 commit e1b464b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
13 changes: 13 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit e1b464b

Please sign in to comment.