From 1fdbdff26dd8b5e75db98ec0b1267f76e06561e9 Mon Sep 17 00:00:00 2001 From: Adam Mathes Date: Mon, 23 Jan 2017 20:49:33 -0800 Subject: readme adds --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 7523ba4..c5ca15f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ RSS Reader focused on cat ears mode *the cat ears are in your mind* +Personal web based RSS reader thing + ## Huh? I decided I didn't like the [old version that was python and mongo](https://github.com/adammathes/neko_v1) so rewrote it. I wanted to learn some Go. So assume the code is bad since I don't know what I'm doing even more so than normal. @@ -12,6 +14,22 @@ The javascript frontend is still the same, I might rewrite that too since it's o This is not very easy to use/setup/or anything. Sorry! Consider it WIP. +## Features + + * limited features (#1 feature) + * keyboard shortcuts + * j -- next item + * k -- previous item + * that's all you should ever need + * web ui + +## TODO + + * OPML import/export + * feeds.txt import/export + * mark all as read + * comments/documentation + ## Installation 1. [Install golang](https://golang.org) -- cgit v1.2.3