Add Roadmap and Contribution sections to README

5 files changed, 59 insertions, 2 deletions

diff --git a/README.md b/README.md
index 790e50d..5094d04 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 vim-hackernews
 ==============
 
-Browse [Hacker News](https://news.ycombinator.com) from inside Vim.
+Browse [Hacker News](https://news.ycombinator.com) inside Vim.
 
 ![Hacker News Front Page in Vim](https://github.com/ryanss/vim-hackernews/raw/master/screenshots/vim-hackernews-home.png)
 
@@ -43,6 +43,27 @@ NeoBundle 'ryanss/vim-hackernews'
 ```
 
 
+Roadmap
+-------
+
+* Add option to format text like different programming languages to make it
+  less obvious that you are reading Hacker News in Vim
+* Add configuration value for custom text width
+* Add configuration value to specify external browser
+* Move away from unofficial API by creating server to cache official Hacker
+  News API data
+* Move away from fuckyeahmarkdown.com by creating server that uses
+  python-readability to convert article HTML to text
+
+
+Contributions
+-------------
+
+[Issues](https://github.com/ryanss/vim-hackernews/issues) and
+[Pull Requests](https://github.com/ryanss/vim-hackernews/pulls) are always
+welcome!
+
+
 License
 -------
 
diff --git a/ftplugin/hackernews.vim b/ftplugin/hackernews.vim
index 590463c..50309c4 100644
--- a/ftplugin/hackernews.vim
+++ b/ftplugin/hackernews.vim
@@ -1,2 +1,11 @@
+"  vim-hackernews
+"  --------------
+"  Browse Hacker News (news.ycombinator.com) inside Vim.
+"
+"  Author:  ryanss <ryanssdev@icloud.com>
+"  Website: https://github.com/ryanss/vim-hackernews
+"  License: MIT (see LICENSE file)
+
+
 noremap o :python hacker_news_link()<cr>
 noremap O :python hacker_news_link(external=True)<cr>
diff --git a/plugin/hackernews.py b/plugin/hackernews.py
index e24974a..29a1b84 100644
--- a/plugin/hackernews.py
+++ b/plugin/hackernews.py
@@ -1,5 +1,14 @@
 # -*- coding: utf-8 -*-
 
+#  vim-hackernews
+#  --------------
+#  Browse Hacker News (news.ycombinator.com) inside Vim.
+#
+#  Author:  ryanss <ryanssdev@icloud.com>
+#  Website: https://github.com/ryanss/vim-hackernews
+#  License: MIT (see LICENSE file)
+
+
 import HTMLParser
 import json
 import re
diff --git a/plugin/hackernews.vim b/plugin/hackernews.vim
index 768f136..d93195a 100644
--- a/plugin/hackernews.vim
+++ b/plugin/hackernews.vim
@@ -1,13 +1,25 @@
+"  vim-hackernews
+"  --------------
+"  Browse Hacker News (news.ycombinator.com) inside Vim.
+"
+"  Author:  ryanss <ryanssdev@icloud.com>
+"  Website: https://github.com/ryanss/vim-hackernews
+"  License: MIT (see LICENSE file)
+
+
 if !has('python')
     echo "HackerNews.vim Error: Requires Vim compiled with +python"
     finish
 endif
 
+
 " Import Python code
 execute "python import sys"
 execute "python sys.path.append('" . expand("<sfile>:p:h") . "')"
 execute "python from hackernews import hacker_news, hacker_news_link"
 
+
 command! HackerNews python hacker_news()
 
+
 au! BufRead,BufNewFile *.hackernews set filetype=hackernews
diff --git a/syntax/hackernews.vim b/syntax/hackernews.vim
index 2cf6bfc..cdd191d 100644
--- a/syntax/hackernews.vim
+++ b/syntax/hackernews.vim
@@ -1,4 +1,10 @@
-" Vim syntax file
+"  vim-hackernews
+"  --------------
+"  Browse Hacker News (news.ycombinator.com) inside Vim.
+"
+"  Author:  ryanss <ryanssdev@icloud.com>
+"  Website: https://github.com/ryanss/vim-hackernews
+"  License: MIT (see LICENSE file)
 
 
 if exists("b:current_syntax")