Add basic README

1 files changed, 28 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e0ece61
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+vim-hackernews
+==============
+
+Browse [Hacker News](https://news.ycombinator.com) from inside Vim.
+
+Uses [cheeaun's Unofficial Hacker News API](https://github.com/cheeaun/node-hnapi)
+to retrieve home page stories and comments and
+[FUCK YEAH MARKDOWN](http://fuckyeahmarkdown.com) for rendering HTML articles
+as text.
+
+
+Installation
+------------
+
+##### Pathogen (https://github.com/tpope/vim-pathogen)
+```bash
+git clone https://github.com/ryanss/vim-hackernews ~/.vim/bundle/vim-hackernews
+```
+
+##### Vundle (https://github.com/gmarik/vundle)
+```
+Plugin 'ryanss/vim-hackernews'
+```
+
+##### NeoBundle (https://github.com/Shougo/neobundle.vim)
+```
+NeoBundle 'ryanss/vim-hackernews'
+```