From 2844931eddc7eb10e314b9072379b51a07b740d3 Mon Sep 17 00:00:00 2001
From: Kristoffer Ahl <mail@77dynamite.com>
Date: Sun, 28 Feb 2021 19:19:52 +0100
Subject: [PATCH] Started documenting commands.

---
 docs/index.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 docs/index.md

diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..79cf865
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,45 @@
+# Documentation
+
+- Getting started (see README)
+- Commands
+    - Properties
+    - Annotations
+    - Root level commands
+    - Sub commands
+- Options
+    - Properties
+    - Annotations
+    - Global options
+    - Command options
+- Scripts
+- Configuration
+    - Application properties
+        - Name
+        - Description
+        - Version
+    - Log
+        - Level
+        - Prefix
+- Help
+- Autocompletion
+
+## Commands
+
+### Properties
+
+| Property        | Description                                          | YAML key      | Type   | Required |
+|-------------|------------------------------------------------------|---------------|--------|----------|
+| Name  | The name of the command   | `name`  | string  | true  |
+| Path   | Relative path to the script containing the command   | `path`  | string  | true  |
+| Description | Description of the command, displayed in help output | `description` | string | false    |
+| Help   | Usage example for the command  | `help`  | string  | false  |
+| Hidden   | When set to true, hides the command from help output  | `hidden`  | boolean   | false  |
+
+
+### Annotations
+
+| Property    | Format                                        |
+|-------------|-----------------------------------------------|
+| Description | `# centry.cmd[<command>]/description=<value>` |
+| Help        | `# centry.cmd[<command>]/help=<value>`        |
+| Hidden      | `# centry.cmd[<command>]/hidden=<value>`      |