summaryrefslogtreecommitdiff
path: root/plugins/localstack/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/localstack/README.md')
-rw-r--r--plugins/localstack/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/plugins/localstack/README.md b/plugins/localstack/README.md
new file mode 100644
index 000000000..2c71e9edf
--- /dev/null
+++ b/plugins/localstack/README.md
@@ -0,0 +1,24 @@
+# Localstack plugin #
+
+CLI support for LOCALSTACK interaction
+
+## Description ##
+To use it, add `localstack` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... localstack)
+```
+
+## Usage ##
+
+This plugin supplies one command, `lsk`, through which all its features are exposed.
+
+## Commands
+
+| Command | Description |
+| :------------ | :-------------------------------------------------------------------- |
+| `lsk sqs-send <queue> <message.json>` | sends a given message in sqs to a given queue |
+
+## Examples
+
+![staging](sqs-send-result.png)