aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2ddcf04
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# edit-weechat
+
+This simple [weechat](https://weechat.org/) plugin allows you to
+compose messages in your `$EDITOR`.
+
+# Usage
+
+```sh
+/edit
+# Type some stuff
+# Save and quit
+```
+
+# Installation
+
+Copy the script to `~/.weechat/python/autoload`
+
+```
+mkdir -p ~/.weechat/python/autoload
+wget https://raw.githubusercontent.com/keith/edit-weechat/master/edit ~/.weechat/python/autoload
+```