Update README and changelog

ahrefs · Dec 27, 2024 · bf3888a · bf3888a
1 parent 174a1e6
commit bf3888a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,5 +1,10 @@
 # History
 
+## WIP
+
+- Add options `--json-ocaml-type`, `--only-matching`,
+  `--avoid-dangling-refs`, and `--skip-doc`.
+
 ## 0.0.3
 - Add decimal string format support
 - Add unix-time int format support

diff --git a/README.md b/README.md
@@ -62,6 +62,15 @@ You can call `jsonschema2atd` and `atdgen` in your `dune` file to generate OCaml
    (run %{bin:atdgen} -t %{deps}))))
 ```
 
+Other options can be used to control the output:
+
+- `--json-ocaml-type KEYWORD:MODULE.PATH:TYPE-NAME` to control the defitiion of
+  the `json` type used as default/fallback.
+- `--only-matching REGEXP` to limit the JSONSchema types to convert, when used
+  together with `--avoid-dangling-refs`, missing types are replaced with `json`.
+
+See also `jsonschema2atd --help`.
+
 ## ToDo
 
 - [X] Base types