7e842cddc45b8bdebe1b198e83eb96fd07b37787

Author
Austin Ratcliff <hello@austinratcliff.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

cloudapp: add README (#8229)

Diff

 1diff --git a/plugins/cloudapp/README.md b/plugins/cloudapp/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..62975a63184720a241d9c33e6f36c9fc0da0c065
 4--- /dev/null
 5+++ b/plugins/cloudapp/README.md
 6@@ -0,0 +1,24 @@
 7+# CloudApp plugin
 8+
 9+[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.
10+
11+To use it, add `cloudapp` to the plugins array of your `~/.zshrc` file:
12+
13+```
14+plugins=(... dash)
15+```
16+
17+## Requirements
18+
19+1. [Aaron Russell's `cloudapp_api` gem](https://github.com/aaronrussell/cloudapp_api#installation)
20+
21+2. That you set your CloudApp credentials in `~/.cloudapp` as a simple text file like below:
22+   ```
23+   email
24+   password
25+   ```
26+
27+## Usage
28+
29+- `cloudapp <filename>`: uploads `<filename>` to your CloudApp account, and if you're using
30+  macOS, copies the URL to your clipboard.