summaryrefslogtreecommitdiffhomepage
path: root/tools
diff options
context:
space:
mode:
authorTaryn Musgrave <t.musgrave@f5.com>2024-04-26 11:41:45 +0100
committeravahahn <110854134+avahahn@users.noreply.github.com>2024-04-30 09:14:55 -0700
commit2c4502f8b64095a17b51d28c3f29a8589dc2daaa (patch)
tree039347fbc8886fb9747917d530a143b9d26ffa15 /tools
parentdb3cf3e42d93112278f5e86cca2c886627ef48b2 (diff)
downloadunit-2c4502f8b64095a17b51d28c3f29a8589dc2daaa.tar.gz
unit-2c4502f8b64095a17b51d28c3f29a8589dc2daaa.tar.bz2
tools: Add unitctl section to the README
Co-developed-by: Ava Hahn <a.hahn@f5.com> Signed-off-by: Ava Hahn <a.hahn@f5.com> [ Tweak subject and cli => unitctl in README - Andrew ] Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
Diffstat (limited to 'tools')
-rw-r--r--tools/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/tools/README.md b/tools/README.md
index e7caae34..daa5a9f3 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -6,6 +6,7 @@ should be considered experimental.
* [`setup-unit`](#setup-unit)
* [`unitc`](#unitc)
+* [`unitctl`](#unitctl)
---
@@ -104,3 +105,14 @@ UNIT_CTRL=docker://4d0431488982 unitc /status/requests/total
```
---
+
+## unitctl
+
+### NGINX Unit Rust SDK and unitctl CLI
+
+This project provides a Rust SDK interface to the
+[NGINX UNIT](https://unit.nginx.org/)
+[control API](https://unit.nginx.org/howto/source/#source-startup)
+and a CLI (`unitctl`) that exposes the functionality provided by the SDK.
+
+---