diff options
| author | kaotisk <kaotisk@arching-kaos.org> | 2022-07-24 07:48:27 +0300 |
|---|---|---|
| committer | kaotisk <kaotisk@arching-kaos.org> | 2022-07-24 07:48:27 +0300 |
| commit | 77ee96aff5b215bab4a8fd567b7aa6b6e6b30961 (patch) | |
| tree | e8e40799f8770b57ad645a3133347fa6af1c7e4d /README.md | |
| parent | 7b8baf0e6301b7dbd57e0c0f3433e36d57b3be82 (diff) | |
| download | arching-kaos-tools-77ee96aff5b215bab4a8fd567b7aa6b6e6b30961.tar.gz arching-kaos-tools-77ee96aff5b215bab4a8fd567b7aa6b6e6b30961.tar.bz2 arching-kaos-tools-77ee96aff5b215bab4a8fd567b7aa6b6e6b30961.zip | |
Updated readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 45 |
1 files changed, 23 insertions, 22 deletions
@@ -32,37 +32,38 @@ Install cd arching-kaos-tools sh install.sh ``` -Defaults + +Examples -------- -Installs binaries and scripts on your $HOME folder. +### Add a news article ( `news add` ) -TODO ----- +You could use ZCHAIN with NEWS model. Or MIXTAPE model, or make your own. +``` bash +news add +``` - - [x] - Install on zsh (export ~/bin to $PATH in .zshrc file) - - [x] - Install on bash (the same but to .bashrc file - - [ ] - Make a useful tool of this +This would pop up a vim editor for you to write a news article or whatever is text or markdown format with a title. -Tools +Saving the file, will save it locally, add it to IPFS, sign it, pack detached signature with metadata on a JSON object. Then a block will be created packing your GPG public key, the news/add action with the JSON object and a detached signature of this, timestamp and finally an entry for the previous *zblock*. After that (!) we finally write this as a json object, add it to IPFS, sign it and pack a *zblock*. That, is published over our IPNS zchain key. -- IPFS tool (installer, checker, updater, swarm settings) - - [x] - Installer - - [x] - Checker - - [x] - Updater - - [x] - Swarm setting +### Explore chains ( `enter` ) -- Rename IPFS tool to storage or something - - [ ] - Modular (call per command) - - [ ] - installer - - [ ] - checker - - [ ] - updater - - [ ] - swarm setting +You can view your zchain as a JSON object using `enter`. There are some flags in order to either view other zchains or change the depth of view ( includes or ignores data object and action ). -Examples --------- +``` bash +$ enter -h +enter - Crawl an arching kaos chain +----------------------------------- +Usage: + --help, -h Print this help and exit + --chain <ipns-link>, -n <ipns-link> Crawl specified chain + --show-zblocks-only, -z Show only zblocks + --no-verify, -nV Don't verify signatures -You could use ZCHAIN with NEWS model. Or MIXTAPE model, or make your own. +Note that combined flags don't work for now +Running with no flags crawls your chain +``` Podman (or Docker) ------------------ |