commit 00080cadc91ee12ab0f4b205a5a26f7a85f14403
parent 1d02e108adeb19a0ce672ee3df2390b6e1e4cf09
Author: Paco Esteban <paco@e1e0.net>
Date: Fri, 31 Jul 2020 20:16:01 +0200
add basic README
Diffstat:
| A | README | | | 42 | ++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 42 insertions(+), 0 deletions(-)
diff --git a/README b/README
@@ -0,0 +1,42 @@
+= Incomplete CLI interface to manage your TTRSS account =
+
+For now it can:
+
+* list categories
+* list feeds of a category
+* subscribe to feed
+* subscribe to feed of a Youtube channel automatically, given an url of
+ the form:
+ *
+ *
+ *
+* unsubscribe from feed.
+
+Build:
+
+Go to the `cmd/ttrss-cli` folder and: `go build`
+
+Docs:
+
+Check -h on the different commands
+
+
+NAME:
+ ttrss-cli - interact with your TTRSS instance from the command line
+
+USAGE:
+ ttrss-cli [global options] command [command options] [arguments...]
+
+VERSION:
+ v0.2
+
+COMMANDS:
+ list, ls list feeds
+ categories, cat list categories
+ subscribe, sub subscribe to feed
+ unsubscribe, rm, unsub unsubscribe from feed
+ help, h Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+ --help, -h show help (default: false)
+ --version, -v print the version (default: false)
