summaryrefslogtreecommitdiff
path: root/lib/leap_cli/commands/README
diff options
context:
space:
mode:
Diffstat (limited to 'lib/leap_cli/commands/README')
-rw-r--r--lib/leap_cli/commands/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/leap_cli/commands/README b/lib/leap_cli/commands/README
new file mode 100644
index 00000000..bec78179
--- /dev/null
+++ b/lib/leap_cli/commands/README
@@ -0,0 +1,11 @@
+This directory contains ruby source files that define the available sub-
+commands of the `leap` executable.
+
+For example, the command:
+
+ leap compile
+
+Lives in lib/leap_cli/commands/init.rb
+
+These files use a DSL (called GLI) for defining command suites.
+See https://github.com/davetron5000/gli for more information.