Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,18 @@ Built on [`zig-nostr/nostr`](https://github.com/zig-nostr/nostr).
> relays, including those that require NIP-42 authentication. Downloads are
> ad-hoc signed (not notarized). See [Install](#install).

## The whole app
![Notary: a native home for your key. Zig and Metal, no Electron. Your key stays in the signer.](docs/shots/hero.jpg)

Four screens, which is all of it.
## What it does

| | |
| --- | --- |
| ![Set up your signer: create a new key or import one you already have](docs/shots/setup.jpg) | ![Unlock your signer with your passphrase](docs/shots/unlock.jpg) |
| **Set up.** Create a key or bring one you have. The key is generated and stored by the signer daemon; the app only ever sends the passphrase. | **Unlock.** The key is encrypted at rest. Nothing serves until you unlock it. |
| ![Serving: the bunker URL to copy, and live per-relay status](docs/shots/serving.jpg) | ![A signing request naming itself, waiting for approve or deny](docs/shots/request.jpg) |
| **Serve.** Copy the `bunker://` URL into any Nostr client. Each relay reports its own connection state, so you can see where you are reachable. | **Approve.** Every request names itself and waits. Nothing is signed while you are not looking. |
| | | |
| --- | --- | --- |
| ![The key never arrives: it is created and held by the signer, and this window only forwards your passphrase](docs/shots/panel-setup.jpg) | ![One URL, any client: paste the bunker link into any Nostr app and you are connected](docs/shots/panel-serving.jpg) | ![Nothing signs quietly: every request names itself, and waits, before anything is signed](docs/shots/panel-request.jpg) |

<sub>Real windows, photographed from the running app against a backdrop. Every
pixel inside the window is the app's own.</sub>
<sub>Real windows, photographed from the running app. Every pixel inside the
window is the app's own, so nothing here shows a screen the app cannot draw. The
signer pubkey and `bunker://` URL come from a stub daemon; no real key appears in
any of them.</sub>

## Install

Expand Down
Binary file added docs/shots/hero.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/shots/panel-request.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/shots/panel-serving.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/shots/panel-setup.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/shots/request.jpg
Binary file not shown.
Binary file removed docs/shots/serving.jpg
Binary file not shown.
Binary file removed docs/shots/setup.jpg
Binary file not shown.
Binary file removed docs/shots/unlock.jpg
Binary file not shown.
2 changes: 1 addition & 1 deletion gui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ itself, with no Electron and no WebView anywhere.
> `.app`, shipped as ad-hoc-signed macOS releases (not notarized, see the
> top-level [Install](../README.md#install)).

The four screens are in the [top-level README](../README.md#the-whole-app).
The screens are in the [top-level README](../README.md#what-it-does).

<sub>First-run key setup, then the serving screen, the `bunker://` connection URL
to copy into a client, live per-relay status, and approving a real NIP-46 signing
Expand Down
Loading