aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorkaotisk <kaotisk@arching-kaos.org>2024-03-11 18:31:31 +0200
committerkaotisk <kaotisk@arching-kaos.org>2024-03-11 18:31:31 +0200
commitda4c3d92640f8f8e32eafd8ebc5a707bf0d89961 (patch)
treed756cbd59fff105101b41fc5a1b6d3bb3f131058 /README
parente31fd72048b68daa4dcac1319da0e28cc49c88b7 (diff)
downloadarching-kaos-tools-da4c3d92640f8f8e32eafd8ebc5a707bf0d89961.tar.gz
arching-kaos-tools-da4c3d92640f8f8e32eafd8ebc5a707bf0d89961.tar.bz2
arching-kaos-tools-da4c3d92640f8f8e32eafd8ebc5a707bf0d89961.zip
Turned subcommands into flag like options
Diffstat (limited to 'README')
-rw-r--r--README22
1 files changed, 11 insertions, 11 deletions
diff --git a/README b/README
index d59dd35..a124ec6 100644
--- a/README
+++ b/README
@@ -128,17 +128,17 @@ and pack a *ZBLOCK*. The ZBLOCK is then published over our IPNS zchain key.
Other options... let's try help!
``` console
-$ ak-news help
-ak-news
--------
-#TODO
-All you need to know is that there are two options available:
-help Prints this help message
-index Prints an indexed table of your news files
-import <file> #TODO
-add <file> Creates a data file from the news file you point to
-create Vim is going to pop up, you will write and save your
- newsletter and it's going to be saved
+$ ak news -h
+ak-news - Module to read, create and add zblocks
+================================================
+ -h, --help Prints this help message
+ -l, --local-index Prints an indexed table of your news files
+ -i, --import <file> #TODO
+ -a, --add <file> Creates a data file from the news file you point to
+ -r, --read <zblock> Reads a zblock as a news data
+ -c, --create Vim is going to pop up, you will write and save your
+ newsletter and it's going to be saved
+ -s, --specs Print specs of data block
```
Clearly there is a TODO item. Import is not working so avoid it, or fix it.