From ae83c116494df7a7840545a2c4b14f6f4d1472ff Mon Sep 17 00:00:00 2001 From: CronyAkatsuki Date: Fri, 10 Nov 2023 21:25:14 +0100 Subject: [PATCH] Add usage --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index c62292e..be0cefb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # mfeed very simple miniflux tool, expected for the tool to be piped to other programs. + +## Usage + +``` +$ mfeed +examples: + mfeed create {category_id} {feed_url} + +usage: mfeed [-h] {feeds,categories,create} ... + feeds list all the feeds you have + categories list all the categories you have + create create a new feed + +positional arguments: + {feeds, categories, create} + +options: + -h, --help shows this help page +```