aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2017-12-17 03:14:55 +0100
committerTeddy Wing2017-12-17 03:14:55 +0100
commit75be9abd092b3ea29c787c0e4109acb69b108680 (patch)
tree73f0634942f8d112b953671fbf909f566718a0ba
parent9b5e4726eb2c98aba1aaf6463e80719277cce5dd (diff)
downloadirssi-vimput-75be9abd092b3ea29c787c0e4109acb69b108680.tar.bz2
Add README
Copy the description from the script's `/help` output with some small modifications for new viewers. Include a demo screencast to show the script in action.
-rw-r--r--Demo.gifbin0 -> 190050 bytes
-rw-r--r--README.md23
2 files changed, 23 insertions, 0 deletions
diff --git a/Demo.gif b/Demo.gif
new file mode 100644
index 0000000..dc23e6f
--- /dev/null
+++ b/Demo.gif
Binary files differ
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a11edd4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+irssi-vimput
+============
+
+An Irssi plugin that opens the current input line in a new Tmux split in Vim.
+When the Vim buffer is written, Irssi's prompt will be updated from the contents
+of the buffer. For Vimmers, this makes it faster to make complicated edits to a
+message.
+
+
+# Demo
+![screencast](./Demo.gif)
+
+
+# Configuration
+In order to use this script, a binding _must_ be configured to trigger it. For
+example, to bind Ctrl-X:
+
+ /BIND ^X command script exec Irssi::Script::vimput::vimput
+
+
+## License
+Copyright © 2017 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).