From 49485423e56d1c80919029f03fde0fac60842454 Mon Sep 17 00:00:00 2001 From: DanConwayDev Date: Wed, 24 Jul 2024 16:54:49 +0100 Subject: docs: remove draft nip34 and add fetch from readme to bring it up-to-date --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5caf513..9b0cf45 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ a command-line tool to send and review patches via nostr -* works seemlessly with [gitworkshop.dev](https://gitworkshop.dev) -* fully compatible with [nip34 draft](https://github.com/nostr-protocol/nips/pull/997) -* enables proposals to be managed as branches, similar to GitHub PRs via nip34+ +- works seemlessly with [gitworkshop.dev](https://gitworkshop.dev) +- fully compatible with 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 @@ -12,16 +12,15 @@ see [gitworkshop.dev/ngit](https://gitworkshop.dev/ngit) and [gitworkshop.dev/ab run from the directory of the git repository: -* `ngit init` signal you are this repo's maintainer accepting proposals via nostr -* `ngit send` issue commits as a proposal - -* `ngit list` list proposals; checkout, apply or donwload selected +- `ngit init` signal you are this repo's maintainer accepting proposals via nostr +- `ngit send` issue commits as a proposal +- `ngit list` list proposals; checkout, apply or donwload selected +- `ngit fetch` fetch download latest repository updates to allow `ngit list` usage offline and when on a proposal branch: -* `ngit push` send proposal revision - -* `ngit pull` fetch and apply new proposal commits / revisions linked to branch +- `ngit push` send proposal revision +- `ngit pull` fetch and apply new proposal commits / revisions linked to branch ## Contributions Welcome! @@ -29,4 +28,4 @@ use ngit to submit proposals! [gitworkshop.dev/repo/ngit](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. \ No newline at end of file +install the tool with `cargo install ngit`, use a prebuilt binary or build from source off the master branch. -- cgit v1.2.3