summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorryanss2015-02-07 16:58:27 -0500
committerryanss2015-02-07 16:58:27 -0500
commitfaf7a8cbc47a07a9b05e9f16021b02b2d32cb034 (patch)
treed9128ca1fd10593c6eb2673e8eb21182a2414382 /README.md
parentbe18f98346720e1eef941ae1a5b1b17d4ac14e6d (diff)
downloadvim-hn-faf7a8cbc47a07a9b05e9f16021b02b2d32cb034.tar.gz
Add basic usage notes to the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8cdbb59..4159e92 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,17 @@ to retrieve home page stories and comments and
as text.
+Basic Usage
+-----------
+
+* Open the Hacker News home page in Vim by executing the `:HackerNews` command
+* Press lowercase `o` to open links in Vim
+* Press uppercase `O` to open links in default web browser
+* Press lowercase `u` to go back (or whatever you've remapped `undo` to)
+* Press `Ctrl+r` to go forward (or whatever you're remapped `redo` to)
+* Execute the `:bd` command to close and remove the Hacker News buffer
+
+
Installation
------------