From 92fcb205a36694eb72f3dc28a53dcd1e61e2d0a4 Mon Sep 17 00:00:00 2001 From: perp Date: Sat, 12 Aug 2023 00:19:33 +0100 Subject: [PATCH] :memo: Updated README Redid command help, added alert command help and shortened examples. --- README.md | 48 +++++++++++++++++++++++++++++++++++------------- 1 file changed, 35 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 1504274..82bbfe1 100644 --- a/README.md +++ b/README.md @@ -23,16 +23,18 @@ go install . ``` ## ❓ Commands -| Todo | Working | Broken | -| ------------ | ------- | ------ | -| convert | count | search | -| data(x) | host | domain | -| download (x) | info | | -| org (x) | myip | | -| init | stats | | -| radar (x) | alert | | -| stream (x) | scan | | -| | version | | +| Working | Todo | +| ------- | ------------ | +| count | data (x) | +| host | download (x) | +| init | org (x) | +| info | radar (x) | +| myip | stream (x) | +| stats | domain (x) | +| search | | +| alert | | +| scan | | +| version | | ##### x = limited key ## ⚡️ Usage @@ -45,9 +47,9 @@ Usage: Available Commands: count Return number of results for a search - domain Return domain information host Return host information info Return your account information + init Initialize Shogo myip Return your IP address search Return a search result stats Return facet stats on a search @@ -63,6 +65,26 @@ Flags: Use "shogo [command] --help" for more information about a command. ``` ``` +Manage your network alerts + +Usage: + shogo alert [flags] + shogo alert [command] + +Available Commands: + clear Clear all alerts + create Create an alert + delete Delete an alert + info Return alert information + list Return all the active alerts + +Flags: + --no-color Disable color output + -h, --help help for alert + +Use "shogo alert [command] --help" for more information about a command. +``` +``` Return number of results for a search Usage: @@ -113,12 +135,12 @@ Use "shogo alert [command] --help" for more information about a command. ### Get key information ``` -shogo info -a -p +shogo info -p ``` ### Get query count ``` -shogo count "apache" "nginx" +shogo count apache ``` ### Get alert list