aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Mathes <adam@trenchant.org>2018-06-12 15:01:13 -0700
committerAdam Mathes <adam@trenchant.org>2018-06-12 15:01:13 -0700
commitf280640979d45c64feaccd0f15d4661dbcf3e7dd (patch)
treef39498a159c056052c26421b96bcc2c3fb456b09
parent9e011074bcc80e00e6deb5b914371718e5991ce2 (diff)
downloadneko-f280640979d45c64feaccd0f15d4661dbcf3e7dd.tar.gz
neko-f280640979d45c64feaccd0f15d4661dbcf3e7dd.tar.bz2
neko-f280640979d45c64feaccd0f15d4661dbcf3e7dd.zip
readme updates
-rw-r--r--README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md
index dc03e60..5823baf 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,5 @@
# Neko
-
`neko` is a self-hosted, rss reader focused on simplicity and efficiency.
Backend is written in `Go` and there is a simple javascript frontend and cat ears.
@@ -121,10 +120,20 @@ Depending on your binaries/configs something like --
There's an example configuration for systemd in etc in this repo that should work for modern Linux systems on systemd.
+## Import/Export
+
+Import is a TODO
+
+Export de facto RSS feed standard OPML from the command line with --
+
+ $ neko --export opml
+
+Change `opml` to `text` for a simple list of feed URLs, or `json` for JSON formatted output.
+
+
## TODO
- * OPML import/export
- * feeds.txt import/export
- * mark all as read cmd
- * comments/docs
+ * feed / item import
+ * mark all as read
* rewrite frontend in a modern js framework
+ * less ugly frontend