diff options
| author | DanConwayDev <DanConwayDev@protonmail.com> | 2024-03-01 15:10:07 +0000 |
|---|---|---|
| committer | DanConwayDev <DanConwayDev@protonmail.com> | 2024-03-01 15:10:07 +0000 |
| commit | 8697f2873e22b752f728aab42228145470ec04ed (patch) | |
| tree | 6b945c8739ea9fc0815014942dbe15a8a6ca01e4 /README.md | |
| parent | 8519dc4a10d47747e6df3f47e25c36bf16befe00 (diff) | |
chore: improve readme copy
pointing to gitworkshop.dev for more details
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 7 insertions, 11 deletions
| @@ -1,18 +1,12 @@ | |||
| 1 | # ngit | 1 | # ngit |
| 2 | 2 | ||
| 3 | cli for code collaboration over nostr | 3 | a command-line tool to send and review patches via nostr |
| 4 | 4 | ||
| 5 | It supports both: | 5 | * works seemlessly with [gitworkshop.dev](https://gitworkshop.dev) |
| 6 | 6 | * fully compatible with [nip34 draft](https://github.com/nostr-protocol/nips/pull/997) | |
| 7 | * patches over nostr similar to `git format-patch` and `git send-email` following the [nip34 daft spec](https://github.com/nostr-protocol/nips/pull/997) | 7 | * enables proposals to be managed as branches, similar to GitHub PRs via nip34+ |
| 8 | * branches similar to pull request model popularised by github | ||
| 9 | |||
| 10 | so that users can decide to work with either model using the same nost events. | ||
| 11 | |||
| 12 | the term 'proposals' is used to bridge the divide between 'patches and patch sets over email' and 'PRs' | ||
| 13 | |||
| 14 | patches produced using other nip34 clients will work with the nip34 patch model but wont have branch support. | ||
| 15 | 8 | ||
| 9 | see [gitworkshop.dev/ngit](https://gitworkshop.dev/ngit) and [gitworkshop.dev/about](https://gitworkshop.dev/about) for more details | ||
| 16 | 10 | ||
| 17 | ### Commands | 11 | ### Commands |
| 18 | 12 | ||
| @@ -33,4 +27,6 @@ and when on a proposal branch: | |||
| 33 | 27 | ||
| 34 | use ngit to submit proposals! | 28 | use ngit to submit proposals! |
| 35 | 29 | ||
| 30 | [gitworkshop.dev/repo/ngit](https://gitworkshop.dev/repo/ngit) to report issues and see proposals | ||
| 31 | |||
| 36 | 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 | 32 | 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 |