From 94226d9ca04c06fc65b65c7c475cf4def6496ddd Mon Sep 17 00:00:00 2001 From: mleku Date: Sat, 3 Aug 2024 18:26:05 +0100 Subject: [PATCH] improve readme, bump to v1 --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5795f14..a6101b6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# wordstr +# wordstr.mleku.dev `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. @@ -13,13 +13,13 @@ usage: to generate a word key: ```bash -wordstr from +wordstr.mleku.dev from ``` to convert a word key back to hex and bech32 `nsec` format: ```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 @@ -45,6 +45,8 @@ or if your `GOBIN` refers to a location also present in your `PATH`, installed: go install wordstr.mleku.dev@latest ``` +you will then be able to run it with `wordstr.mleku.dev`. + ## technical details of protocol The implementation found in this repository uses big integers to derive the