summaryrefslogtreecommitdiff
path: root/rule-compiler/README.md
diff options
context:
space:
mode:
authorAdam Ierymenko <adam.ierymenko@zerotier.com>2018-04-25 06:39:02 -0700
committerGitHub <noreply@github.com>2018-04-25 06:39:02 -0700
commit42ec780a6f6eedef4d8b1d8218bd72fc6ed75cc0 (patch)
tree7bf86c4d92d6a0f77eced79bfc33313c62c7b6dd /rule-compiler/README.md
parent18c9dc8a0649c866eff9f299f20fa5b19c502e52 (diff)
parent4608880fb06700822d01e9e5d6729fcdeb82b64b (diff)
downloadinfinitytier-42ec780a6f6eedef4d8b1d8218bd72fc6ed75cc0.tar.gz
infinitytier-42ec780a6f6eedef4d8b1d8218bd72fc6ed75cc0.zip
Merge branch 'dev' into netbsd-support
Diffstat (limited to 'rule-compiler/README.md')
-rw-r--r--rule-compiler/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/rule-compiler/README.md b/rule-compiler/README.md
new file mode 100644
index 00000000..1ceeb713
--- /dev/null
+++ b/rule-compiler/README.md
@@ -0,0 +1,8 @@
+ZeroTier Rules Compiler
+======
+
+This script converts ZeroTier rules in human-readable format into rules suitable for import into a ZeroTier network controller. It's the script that is used in the rules editor on [ZeroTier Central](https://my.zerotier.com/).
+
+A command line interface is included that may be invoked as: `node cli.js <rules script>`.
+
+See the [manual](https://www.zerotier.com/manual.shtml) for information about the rules engine and rules script syntax.