summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorryanss2015-02-07 17:42:52 -0500
committerryanss2015-02-07 17:42:52 -0500
commitea3fe88e3db36aacff9fc1c2a0a8b6b08a8bb840 (patch)
tree79a8c42bcff1c82387a2201a83b05189180f9578 /README.md
parent2af28fab25e90644c9688319f1347680f7c47549 (diff)
downloadvim-hn-ea3fe88e3db36aacff9fc1c2a0a8b6b08a8bb840.tar.gz
Add Roadmap and Contribution sections to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 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
-------