nostr/nak
1
0
Fork 0
mirror of https://github.com/fiatjaf/nak.git synced 2024-11-22 08:19:06 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme and help text.

Browse Source
This commit is contained in:
fiatjaf 2023-05-23 23:26:27 -03:00
parent bbe4bfdaa0
commit 88acf8ccda
No known key found for this signature in database
GPG Key ID: BAD43C4BE5C1A3A1
3 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -44,7 +44,7 @@ USAGE:
COMMANDS: COMMANDS:
req generates encoded REQ messages and optionally use them to talk to relays req generates encoded REQ messages and optionally use them to talk to relays
event generates an encoded event event generates an encoded event and either prints it or sends it to a set of relays
decode decodes nip19, nip21, nip05 or hex entities decode decodes nip19, nip21, nip05 or hex entities
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
@ -53,7 +53,7 @@ GLOBAL OPTIONS:
~> nak event --help ~> nak event --help
NAME: NAME:
nak event - generates an encoded event nak event - generates an encoded event and either prints it or sends it to a set of relays
USAGE: USAGE:
nak event [command options] [arguments...] nak event [command options] [arguments...]
@ -61,6 +61,8 @@ USAGE:
DESCRIPTION: DESCRIPTION:
example usage (for sending directly to a relay with 'nostcat'): example usage (for sending directly to a relay with 'nostcat'):
nak event -k 1 -c hello --envelope | nostcat wss://nos.lol nak event -k 1 -c hello --envelope | nostcat wss://nos.lol
standalone:
nak event -k 1 -c hello wss://nos.lol`,
OPTIONS: OPTIONS:
--envelope print the event enveloped in a ["EVENT", ...] message ready to be sent to a relay (default: false) --envelope print the event enveloped in a ["EVENT", ...] message ready to be sent to a relay (default: false)
@ -87,7 +89,6 @@ DESCRIPTION:
example usage (with 'nostcat'): example usage (with 'nostcat'):
nak req -k 1 -a 3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d | nostcat wss://nos.lol nak req -k 1 -a 3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d | nostcat wss://nos.lol
standalone: standalone:
nak req -k 1 wss://nos.lol nak req -k 1 wss://nos.lol

1
event.go
View File

@ -19,7 +19,6 @@ var event = &cli.Command{
Usage: "generates an encoded event and either prints it or sends it to a set of relays", Usage: "generates an encoded event and either prints it or sends it to a set of relays",
Description: `example usage (for sending directly to a relay with 'nostcat'): Description: `example usage (for sending directly to a relay with 'nostcat'):
nak event -k 1 -c hello --envelope | nostcat wss://nos.lol nak event -k 1 -c hello --envelope | nostcat wss://nos.lol
standalone: standalone:
nak event -k 1 -c hello wss://nos.lol`, nak event -k 1 -c hello wss://nos.lol`,
Flags: []cli.Flag{ Flags: []cli.Flag{

1
req.go
View File

@ -18,7 +18,6 @@ var req = &cli.Command{
example usage (with 'nostcat'): example usage (with 'nostcat'):
nak req -k 1 -a 3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d | nostcat wss://nos.lol nak req -k 1 -a 3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d | nostcat wss://nos.lol
standalone: standalone:
nak req -k 1 wss://nos.lol`, nak req -k 1 wss://nos.lol`,
Flags: []cli.Flag{ Flags: []cli.Flag{