aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md30
-rw-r--r--scrot.jpgbin0 -> 51262 bytes
2 files changed, 26 insertions, 4 deletions
diff --git a/README.md b/README.md
index 107d0a3..38fafa6 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,30 @@
# vim-haredoc
-Vim plugin for the haredoc command -- [Hare documentation][a] in vim.
+Vim plugin for the haredoc command -- [Hare documentation][h] in vim.
-Send patches to <~torresjrjr/public-inbox@lists.sr.ht> ([archive][b]).
+![Usage of the K command](scrot.jpg)
- [a]: https://docs.harelang.org/
- [b]: https://lists.sr.ht/~torresjrjr/public-inbox
+
+## Install
+
+Method 1: Use your preferred Vim plugin manager. E.g. [vim-plug][v]:
+
+ :Plug 'https://git.sr.ht/~torresjrjr/vim-haredoc'
+
+Method 2: Install directly using 'packages' in Vim 8:
+
+ :help packages
+
+In your shell:
+
+ $ git clone https://git.sr.ht/~torresjrjr/vim-haredoc \
+ ~/.vim/pack/plugins/start/vim-haredoc
+
+
+## Resources
+
+Send patches to <~torresjrjr/public-inbox@lists.sr.ht> ([archive][a]).
+
+ [h]: https://docs.harelang.org/
+ [v]: https://github.com/junegunn/vim-plug
+ [a]: https://lists.sr.ht/~torresjrjr/public-inbox
diff --git a/scrot.jpg b/scrot.jpg
new file mode 100644
index 0000000..50f1530
--- /dev/null
+++ b/scrot.jpg
Binary files differ