mleku/wordstr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve readme, bump to v1

Browse Source
This commit is contained in:
mleku
2024-08-03 18:26:05 +01:00
parent f2620e988e
commit 94226d9ca0
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -1,4 +1,4 @@
# wordstr # wordstr.mleku.dev
`wordstr` is a tool to convert a nostr bech32 encoded `nsec` or hexadecimal `wordstr` is a tool to convert a nostr bech32 encoded `nsec` or hexadecimal
encoded secret key into a word mnemonic that can be stored in hard copy. encoded secret key into a word mnemonic that can be stored in hard copy.
@@ -13,13 +13,13 @@ usage:
to generate a word key: to generate a word key:
```bash ```bash
wordstr from <hex/nsec nostr secret key> wordstr.mleku.dev from <hex/nsec nostr secret key>
``` ```
to convert a word key back to hex and bech32 `nsec` format: to convert a word key back to hex and bech32 `nsec` format:
```bash ```bash
wordstr to <27 word mnemonic key> wordstr.mleku.dev to <27 word mnemonic key>
``` ```
the output of the `to` command is formatted as such for easy use in scripts the output of the `to` command is formatted as such for easy use in scripts
@@ -45,6 +45,8 @@ or if your `GOBIN` refers to a location also present in your `PATH`, installed:
go install wordstr.mleku.dev@latest go install wordstr.mleku.dev@latest
``` ```
you will then be able to run it with `wordstr.mleku.dev`.
## technical details of protocol ## technical details of protocol
The implementation found in this repository uses big integers to derive the The implementation found in this repository uses big integers to derive the