From 5d0253dfaa896b25006be38155c900158f89973c Mon Sep 17 00:00:00 2001
From: DanConwayDev <DanConwayDev@protonmail.com>
Date: Tue, 20 Aug 2024 10:42:48 +0100
Subject: docs: add git-remote-nostr content to readme

and include a primer on how it works
---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 44 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 9b0cf45..53aa611 100644
--- a/README.md
+++ b/README.md
@@ -3,12 +3,52 @@
 a command-line tool to send and review patches via nostr
 
 - works seemlessly with [gitworkshop.dev](https://gitworkshop.dev)
-- fully compatible with nostr git protocol (nip34)
+- fully implements nostr git protocol (nip34)
 - enables proposals to be managed as branches, similar to GitHub PRs, or patches similar to patches-over-email
 
 see [gitworkshop.dev/ngit](https://gitworkshop.dev/ngit) and [gitworkshop.dev/about](https://gitworkshop.dev/about) for more details
 
-### Commands
+## git-remote-nostr
+
+a git remote helper (git plugin) included with ngit that enables nostr integration with native git commands when used with a nostr remote eg nostr://npub123/identifer
+
+- repository state stored in a nostr event with git server(s) used for data sync
+- treats open proposals branches prefixed `pr/*`
+
+## primer
+
+nostr is a decentralised communications protocol with:
+
+- permissionless account creation - created via a public/private key pair
+- verifiable signed messages
+- messages transported via relays rather than P2P
+
+for code collaboration, nostr is used for:
+
+- repository identification and discovery
+- state (ie. git refs)
+- proposals (PRs), issues and related discussion
+
+a git server is still required for data storage and syncing state. multiple git servers can be used for reduncancy and they can be seemlessly swapped out by maintainers just like nostr relays.
+
+eg self-hosted, github, codeberg, etc.
+
+```
+             ┌──────────┐
+             │  Author  │
+             └──/─┬─\───┘
+        ,------'  │  '--------.-------.
+┌──────▼─┐   ┌────▼───┐   ┌───▼───┐  ┌─▼─────┐  ┌───────┐
+│  Git   │   │  Git   │   │ Relay │  │ Relay │  │ Relay │
+│ Server │   │ Server │   │       │  │       │  │       │
+└────────┘   └────\───┘   └───┬───┘  └──/────┘  └─/─────┘
+                   \------.   │   ,----/---------/
+                         ┌─▼──▼──▼─┐
+                         │  User   │
+                         └─────────┘
+```
+
+### ngit commands
 
 run from the directory of the git repository:
 
@@ -22,10 +62,10 @@ and when on a proposal branch:
 - `ngit push` send proposal revision
 - `ngit pull` fetch and apply new proposal commits / revisions linked to branch
 
-## Contributions Welcome!
+## contributions welcome!
 
 use ngit to submit proposals!
 
-[gitworkshop.dev/repo/ngit](https://gitworkshop.dev/repo/ngit) to report issues and see proposals
+[gitworkshop.dev/r/naddr1qqzxuemfwsq3gamnwvaz7tmjv4kxz7fwv3sk6atn9e5k7q3q5qydau2hjma6ngxkl2cyar74wzyjshvl65za5k5rl69264ar2exsxpqqqpmejawq4qj](https://gitworkshop.dev/repo/ngit) to report issues and see proposals
 
 install the tool with `cargo install ngit`, use a prebuilt binary or build from source off the master branch.
-- 
cgit v1.2.3