From: Alexander Barton <alex@barton.de>
Date: Mon, 22 Apr 2019 15:46:57 +0000 (+0200)
Subject: plugins/README.md: Initial plugin documentation
X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ax-zsh.git;a=commitdiff_plain;h=ab7eb1ebf4f6c7718c92ae416f75ec662405f9ab

plugins/README.md: Initial plugin documentation

For now, only a few hints ...
---

diff --git a/plugins/README.md b/plugins/README.md
new file mode 100644
index 0000000..2bd2598
--- /dev/null
+++ b/plugins/README.md
@@ -0,0 +1,21 @@
+AX-ZSH: Alex' Modular ZSH Configuration - Plugin Documentation
+==============================================================
+
+Plugin Exit Codes
+-----------------
+
+- 0: OK
+- 1: Error
+- 91: Ignore
+- 92: Optional
+
+
+Detecting "Plugin Check" Run
+----------------------------
+
+When `axzshctl check-plugins` is doing a _plugin check_ run, the enviromnet
+variable `AXZSH_PLUGIN_CHECK` is "non-zero"; this can be tested like this:
+
+```
+[[ -z "$AXZSH_PLUGIN_CHECK" ]] || return 92
+```