summaryrefslogtreecommitdiff
path: root/plugins/cloudapp/README.md
diff options
context:
space:
mode:
authorAustin Ratcliff <hello@austinratcliff.com>2019-10-07 11:50:01 -0500
committerMarc Cornellà <marc.cornella@live.com>2019-10-07 18:50:01 +0200
commit7e842cddc45b8bdebe1b198e83eb96fd07b37787 (patch)
tree504bb661cf78284164956d5c448299cd46cc7da5 /plugins/cloudapp/README.md
parentfdebc2272e8789e9120ab9b195754e423990b317 (diff)
downloadzsh-7e842cddc45b8bdebe1b198e83eb96fd07b37787.tar.gz
zsh-7e842cddc45b8bdebe1b198e83eb96fd07b37787.tar.bz2
zsh-7e842cddc45b8bdebe1b198e83eb96fd07b37787.zip
cloudapp: add README (#8229)
Diffstat (limited to 'plugins/cloudapp/README.md')
-rw-r--r--plugins/cloudapp/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/plugins/cloudapp/README.md b/plugins/cloudapp/README.md
new file mode 100644
index 000000000..62975a631
--- /dev/null
+++ b/plugins/cloudapp/README.md
@@ -0,0 +1,24 @@
+# CloudApp plugin
+
+[CloudApp](https://www.getcloudapp.com) brings screen recording, screenshots, and GIF creation to the cloud, in an easy-to-use enterprise-level app. The CloudApp plugin allows you to upload a file to your CloadApp account from the command line.
+
+To use it, add `cloudapp` to the plugins array of your `~/.zshrc` file:
+
+```
+plugins=(... dash)
+```
+
+## Requirements
+
+1. [Aaron Russell's `cloudapp_api` gem](https://github.com/aaronrussell/cloudapp_api#installation)
+
+2. That you set your CloudApp credentials in `~/.cloudapp` as a simple text file like below:
+ ```
+ email
+ password
+ ```
+
+## Usage
+
+- `cloudapp <filename>`: uploads `<filename>` to your CloudApp account, and if you're using
+ macOS, copies the URL to your clipboard.