summaryrefslogtreecommitdiffhomepage
path: root/tools/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/README.md')
-rw-r--r--tools/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/tools/README.md b/tools/README.md
new file mode 100644
index 00000000..7dbf0781
--- /dev/null
+++ b/tools/README.md
@@ -0,0 +1,16 @@
+# Unit Tools
+
+This directory contains useful tools for installing, configuring, and
+managing NGINX Unit. They may not be part of official packages and
+should be considered experimental.
+
+---
+
+## setup-unit
+
+### A script that simplifies installing and configuring an NGINX Unit server for first-time users
+
+* `setup-unit repo-config` configures your package manager with the NGINX
+Unit repository for later installation.
+* `setup-unit welcome` creates an initial configuration to serve a welcome
+web page with NGINX Unit.