aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar sommerfeld <sommerfeld@sommerfeld.dev>2024-07-05 15:21:03 +0100
committerLibravatar sommerfeld <sommerfeld@sommerfeld.dev>2024-07-05 15:30:41 +0100
commitdb13ee769d674d9fd8b30e79dca974ff93c018c4 (patch)
treeea56844bc38a02452e80d1c3fa873f8c466170ff /README.md
parent2d6043d7a67b0f6304dc7a2bb92677009a96f19d (diff)
downloadviewercount-db13ee769d674d9fd8b30e79dca974ff93c018c4.tar.gz
viewercount-db13ee769d674d9fd8b30e79dca974ff93c018c4.tar.bz2
viewercount-db13ee769d674d9fd8b30e79dca974ff93c018c4.zip
Generate nostrconnect URI by default
Instead of asking for the user to generate a nsecbunker in another NIP46 signer app and copy pasting here. The former behavior can still be achieved by passing --use-nsecbunker.
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index aa4d1e3..bd10c92 100644
--- a/README.md
+++ b/README.md
@@ -50,15 +50,20 @@ Arguments:
Options:
-i, --interval <INTERVAL> watch interval in seconds [default: 60]
--reset-nip46 remove previously cached NIP46 signer credentials and ask for new ones
+ --use-nsecbunker use an externally provided nsecbunker URI instead of generating a nostrconnectURI by default
-h, --help Print help
-V, --version Print version
```
-You can just run it without any arguments. It will ask for a [NIP46 nsecbunker
-URI](https://github.com/nostr-protocol/nips/blob/master/46.md) which you can
-easily obtain if using [Amber](https://github.com/greenart7c3/Amber),
+You can just run it without any arguments. It will provide you with a in-client
+auto generated
+[NIP46 nostrconnect URI](https://github.com/nostr-protocol/nips/blob/master/46.md)
+which you can use to login remotely using [Amber](https://github.com/greenart7c3/Amber),
[Keystache](https://github.com/Resolvr-io/Keystache),
-[nsec.app](https://nsec.app/) or [nsecbunker.com](https://nsecbunker.com/).
+[nsec.app](https://nsec.app/) or [nsecbunker.com](https://nsecbunker.com/). If
+the app does not have good support for generated `nostrconnect://` URIs, you can
+pass `--use-nsecbunker` and paste a nsecbunker URI instead of scanning a QR
+code.
You just need to copy paste the URI on the first run, and it will then use your
[NIP65 outbox relays](https://github.com/nostr-protocol/nips/blob/master/65.md)