From 26b1835efa72a4555fb4717e52b100e28c5658dc Mon Sep 17 00:00:00 2001
From: kaotisk <kaotisk@arching-kaos.org>
Date: Sun, 7 Jul 2024 08:51:39 +0300
Subject: Added HIA-based scanning mode for CJDNS

---
 README | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'README')

diff --git a/README b/README
index 77c0836..94a4816 100644
--- a/README
+++ b/README
@@ -180,6 +180,31 @@ Running with no flags crawls your chain based on AK_ZLATEST environment
 variable
 ```
 
+### Connect to networks ( `ak network` )
+```console
+$ ak network
+ak-network - AK Nettool
+=======================
+
+Network tools
+
+Usage:
+
+   -h, --help                           Prints this help message
+
+   -c, --connect [ipfs|cjdns]           Connect to network(s)
+
+   -p, --peers [ipfs|cjdns|stellar]     Outputs peers found
+
+   -s, --scan [ipfs|cjdns|stellar]      Scan network(s) for peers
+
+Bonus: CJDNS network scanning flags
+
+   -s, --scan cjdns [-w|--whole]        Scan using HIA's knowledge
+
+   -s, --scan cjdns [-d|--dump]         Scan using CJDNS' dumpLinks (default)
+```
+
 Podman (or Docker)
 ------------------
 
-- 
cgit v1.2.3