Add README

sirhc · Mar 23, 2020 · 99650f5 · 99650f5
1 parent f5e76f6
commit 99650f5
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# AWS Okta (aws-okta) plugin
+
+This plugin provides command line completions for the
+[`aws-okta`](https://github.com/segmentio/aws-okta) command.
+
+This plugin provides the following convenience functions.
+
+| Function | Purpose |
+| --- | --- |
+| `aop <profile>` | Execute `aws-okta env <profile>` and set the token in the current shell |
+
+To use the plugin, add `okta` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... okta)
+```