gemini.vim

commit 8a7adbfcf8a5393a0c3f5d555f99898788c9abf5
parent aa6321974cf69d8b6625dbfd99539ecda3849dc9
Author: Byron Torres <b@torresjrjr.com>
Date:   Wed, 14 Apr 2021 21:48:23 +0100

README.md: Add screenshot, installation, resources

Diffstat:
M
README.md
 | 
37
++++++++++++++++++++++++++++++++-----

1 file changed, 32 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -1,9 +1,36 @@
 gemini.vim
 ==========
 
-Vim syntax highlighting plugin for Gemini Text, the text/gemini media type,
-as defined in the *Gemini protocol specification v0.14.12, July 2nd 2020*
-([gemini][1], [http][2]).
+Vim syntax highlighting plugin for [Gemini][gmi] Text,
+the text/gemini media type, as defined in
+the *Gemini protocol specification v0.14.12 (2020-07-02)*
+[[gemini][1], [http][2]].
 
-[1]: gemini://gemini.circumlunar.space/docs/specification.gmi
-[2]: https://gemini.circumlunar.space/docs/specification.html
+![gemini.vim screenshot](https://i.imgur.com/mJudlhe.jpg)
+
+
+Install
+-------
+
+Install as a Vim plugin in your runtimepath.
+
+	:help mysyntaxfile
+	:help ftdetect
+
+Alternatively, use a Vim plugin manager.  For [vim-plug][vp]:
+
+	Plug 'https://git.sr.ht/~torresjrjr/gemini.vim'
+
+
+Resources
+---------
+
+- Project site: <https://sr.ht/~torresjrjr/gemini.vim>
+- Mailing list: <~torresjrjr/public-inbox@list.sr.ht>
+- License: GNU General Public License
+
+
+  [gmi]: https://gemini.circumlunar.space/
+  [vp]: https://github.com/junegunn/vim-plug
+  [1]: gemini://gemini.circumlunar.space/docs/specification.gmi
+  [2]: https://gemini.circumlunar.space/docs/specification.html