Skip to content

Commit 07a094a

Browse files
update readme about maintenance
1 parent 97b00c6 commit 07a094a

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,20 @@ So that you don't have to write values.schema.json by hand from scratch for your
66

77
[Helm](https://helm.sh) plugin to generate [JSON Schema for values yaml](https://helm.sh/docs/topics/charts/#schema-files)
88

9+
## Note about maintenance
10+
11+
I currently don't have the bandwidth to reply to issues, write code and review PRs. For now I recommend forking the repo and making changes and using the fork 😅
12+
13+
## Code stuff
14+
915
Nothing fancy about the code, all the heavy lifting is done by:
1016

1117
- [go-jsonschema-generator](https://github.com/karuppiah7890/go-jsonschema-generator) - for generating JSON schema. It's a fork of [this](https://github.com/mcuadros/go-jsonschema-generator). Thanks to [@mcuadros](https://github.com/mcuadros)
1218
- [go-yaml](https://github.com/go-yaml/yaml/) - for YAML parsing
1319
- [cobra](https://github.com/spf13/cobra) - for CLI stuff
1420
- [The Go stdlib](https://golang.org/pkg/) - for everything else
1521

22+
1623
## Install
1724

1825
The plugin works with both Helm v2 and v3 versions as it's agnostic to the Helm
@@ -215,6 +222,8 @@ $ helm schema-gen values.yaml > values.schema.json
215222

216223
## Issues? Feature Requests? Proposals? Feedback?
217224

225+
Note: I currently don't have the bandwidth to reply to issues, write code and review PRs. For now I recommend forking the repo and making changes and using the fork 😅
226+
218227
Put them all in [GitHub issues](https://github.com/karuppiah7890/helm-schema-gen/issues) 😁
219228
I value every feedback. I really want to make sure that my tools help people and does not
220229
annoy people. I want my tools to enable people and not hinder them. I'll do my best to help you

0 commit comments

Comments
 (0)