Add documentation file

2 files changed, 28 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index 0d20b64..c6537e4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
 *.pyc
+doc/tags
diff --git a/doc/hackernews.txt b/doc/hackernews.txt
new file mode 100644
index 0000000..d0ed099
--- /dev/null
+++ b/doc/hackernews.txt
@@ -0,0 +1,27 @@
+*hackernews.txt*  Browse HackerNews inside Vim  *hackernews*
+
+Author:  ryanss <ryanssdev@icloud.com>
+Website: https://github.com/ryanss/vim-hackernews
+License: MIT (see LICENSE file)
+
+
+BASIC USAGE                                     *hackernews-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
+
+
+COMMANDS                                        *hackernews-commands*
+
+:HackerNews             Open Hacker News front page stories in Vim
+
+
+ABOUT                                           *hackernews-about*
+
+Grab the latest version or report a bug on GitHub:
+
+https://github.com/ryanss/vim-hackernews