nostr/nak
1
0
Fork 0
mirror of https://github.com/fiatjaf/nak.git synced 2024-10-30 09:09:08 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

add nak encode to readme.

Browse Source
This commit is contained in:
fiatjaf 2023-07-05 15:05:09 -03:00
parent 4ad0769a62
commit fb7c49bb5c
No known key found for this signature in database
GPG Key ID: BAD43C4BE5C1A3A1
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -56,6 +56,7 @@ 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 and either prints it or sends it to a set of relays 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
encode encodes notes and other stuff to nip19 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
GLOBAL OPTIONS: GLOBAL OPTIONS:
@ -154,6 +155,34 @@ OPTIONS:
--id, -e return just the event id, if applicable (default: false) --id, -e return just the event id, if applicable (default: false)
--pubkey, -p return just the pubkey, if applicable (default: false) --pubkey, -p return just the pubkey, if applicable (default: false)
--help, -h show help --help, -h show help
~> nak encode --help
NAME:
nak encode - encodes notes and other stuff to nip19 entities
USAGE:
nak encode command [command options] [arguments...]
DESCRIPTION:
example usage:
nak encode npub <pubkey-hex>
nak encode nprofile <pubkey-hex>
nak encode nprofile --relay <relay-url> <pubkey-hex>
nak encode nevent <event-id>
nak encode nevent --author <pubkey-hex> --relay <relay-url> --relay <other-relay> <event-id>
nak encode nsec <privkey-hex>
COMMANDS:
npub encode a hex private key into bech32 'npub' format
nsec encode a hex private key into bech32 'nsec' format
nprofile generate profile codes with attached relay information
nevent generate event codes with optionally attached relay information
naddr generate codes for NIP-33 parameterized replaceable events
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help
``` ```
written in go using [go-nostr](https://github.com/nbd-wtf/go-nostr), heavily inspired by [nostril](http://git.jb55.com/nostril/). written in go using [go-nostr](https://github.com/nbd-wtf/go-nostr), heavily inspired by [nostril](http://git.jb55.com/nostril/).