From fdcbb845ddc5cc646cfa01f590b0ea331c31f80b Mon Sep 17 00:00:00 2001
From: Daniil Baturin <daniil@baturin.org>
Date: Wed, 22 May 2024 13:57:11 +0100
Subject: T6380: Add an actual README

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

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.
-- 
cgit v1.2.3