summaryrefslogtreecommitdiff
path: root/plugins/coffee/README
diff options
context:
space:
mode:
authorCooper Maruyama <cooperm@susteen.com>2015-05-02 07:16:27 -0700
committerCooper Maruyama <cooperm@susteen.com>2015-05-02 07:16:27 -0700
commitd80918bf981d5df3f192346b44c0c35636ee7b2b (patch)
treea5a51114bd40799df6c8103e12ebc12d89682a3f /plugins/coffee/README
parent24552f02259829428c412a88729de4cfd0b7ba8b (diff)
downloadzsh-d80918bf981d5df3f192346b44c0c35636ee7b2b.tar.gz
zsh-d80918bf981d5df3f192346b44c0c35636ee7b2b.tar.bz2
zsh-d80918bf981d5df3f192346b44c0c35636ee7b2b.zip
add markdown extension to README
Diffstat (limited to 'plugins/coffee/README')
-rw-r--r--plugins/coffee/README31
1 files changed, 0 insertions, 31 deletions
diff --git a/plugins/coffee/README b/plugins/coffee/README
deleted file mode 100644
index d0e7bbe74..000000000
--- a/plugins/coffee/README
+++ /dev/null
@@ -1,31 +0,0 @@
-## Coffeescript Plugin
-
-This plugin provides aliases for quickly compiling and previewing your
-cofeescript code.
-
-When writing Coffeescript it's very common to want to preview the output of a
-certain snippet of code, either because you want to test the output or because
-you'd like to execute it in a browser console which doesn't accept Coffeescript.
-
-Preview the compiled result of your coffeescript with `cf "code"` as per the
-following:
-
-```zsh
-$ cf 'if a then be else c'
-if (a) {
- b;
-} else {
- c;
-}
-```
-
-Also provides the following aliases:
-
-* **cfc:** Copies the compiled JS to your clipboard. Very useful when you want
- to run the code in a JS console.
-
-* **cfp:** Compiles from your currently copied clipboard. Useful when you want
- to compile large/multi-line snippets
-
-* **cfpc:** Paste coffeescript from clipboard, compile to JS, then copy the
- the result back to clipboard.