Merge pull request #22 from dmbaturin/reorg

T6380: Reorganize the directory structure and reflect it in the README

8 files changed, 14 insertions, 1 deletions

diff --git a/README.md b/README.md
index ce3f1fe..26918cd 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# vyos-utils
\ No newline at end of file
+# vyos-utils
+
+This repository contains utility binaries used by the VyOS CLI,
+written in OCaml for speed and memory safety.
+
+Currently, they are:
+
+* `validate_value` — the top-level validation utility that checks regexes and executes external validators.
+* `validators` — validator executables:
+  * `file_path` — checks directory and file paths.
+  * `numeric` — checks numbers and number ranges.
+  * `url` — checks URLs/URIs.
+* `completion` — completion helpers:
+  * `list_interfaces` — produces lists of network interfaces.
diff --git a/src/iface/func.ml b/src/completion/list_interfaces/func.ml
index 13e1860..13e1860 100644
--- a/src/iface/func.ml
+++ b/src/completion/list_interfaces/func.ml
diff --git a/src/iface/func.mli b/src/completion/list_interfaces/func.mli
index b16d373..b16d373 100644
--- a/src/iface/func.mli
+++ b/src/completion/list_interfaces/func.mli
diff --git a/src/iface/iface.c b/src/completion/list_interfaces/iface.c
index bf2f025..bf2f025 100644
--- a/src/iface/iface.c
+++ b/src/completion/list_interfaces/iface.c
diff --git a/src/iface/list_interfaces.ml b/src/completion/list_interfaces/list_interfaces.ml
index fec5c9c..fec5c9c 100644
--- a/src/iface/list_interfaces.ml
+++ b/src/completion/list_interfaces/list_interfaces.ml
diff --git a/src/file_path.ml b/src/validators/file_path.ml
index ea3068c..ea3068c 100644
--- a/src/file_path.ml
+++ b/src/validators/file_path.ml
diff --git a/src/numeric.ml b/src/validators/numeric.ml
index 0c75f83..0c75f83 100644
--- a/src/numeric.ml
+++ b/src/validators/numeric.ml
diff --git a/src/url.ml b/src/validators/url.ml
index 3d77544..3d77544 100644
--- a/src/url.ml
+++ b/src/validators/url.ml