Update README.md with supported formats, contact info
All checks were successful
CI / test (push) Successful in 38s
Lint / test (push) Successful in 22s
Trivy / test (push) Successful in 22s

This commit is contained in:
Miguel Jacq 2025-11-25 17:40:47 +11:00
parent 559389a35c
commit b33e25a35f
Signed by: mig5
GPG key ID: 59B3F0C24135C6A9

View file

@ -19,6 +19,15 @@ of software.
By default, the Jinja2 template and the `defaults/main.yml` are printed to By default, the Jinja2 template and the `defaults/main.yml` are printed to
stdout. However, it is possible to output the results to new files. stdout. However, it is possible to output the results to new files.
## What sort of config files can it handle?
TOML, YAML, INI and JSON style config files should be okay. There are always
going to be some edge cases in very complex files that are difficult to work
with, though, so you may still find that you need to tweak the results.
The goal here is really to *speed up* converting files into Ansible/Jinja2,
but not necessarily to make it perfect.
## How to install it ## How to install it
### From PyPi ### From PyPi
@ -74,3 +83,9 @@ options:
Path to write the Jinja2 config template. If omitted, template is printed to stdout. Path to write the Jinja2 config template. If omitted, template is printed to stdout.
``` ```
## Found a bug, have a suggestion?
You can e-mail me (see the pyproject.toml for details) or contact me on the Fediverse:
https://goto.mig5.net/@mig5