summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 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.