diff options
| -rw-r--r-- | README.md | 21 |
1 files changed, 10 insertions, 11 deletions
| @@ -2,9 +2,9 @@ | |||
| 2 | 2 | ||
| 3 | a command-line tool to send and review patches via nostr | 3 | a command-line tool to send and review patches via nostr |
| 4 | 4 | ||
| 5 | * works seemlessly with [gitworkshop.dev](https://gitworkshop.dev) | 5 | - works seemlessly with [gitworkshop.dev](https://gitworkshop.dev) |
| 6 | * fully compatible with [nip34 draft](https://github.com/nostr-protocol/nips/pull/997) | 6 | - fully compatible with nostr git protocol (nip34) |
| 7 | * enables proposals to be managed as branches, similar to GitHub PRs via nip34+ | 7 | - enables proposals to be managed as branches, similar to GitHub PRs, or patches similar to patches-over-email |
| 8 | 8 | ||
| 9 | see [gitworkshop.dev/ngit](https://gitworkshop.dev/ngit) and [gitworkshop.dev/about](https://gitworkshop.dev/about) for more details | 9 | see [gitworkshop.dev/ngit](https://gitworkshop.dev/ngit) and [gitworkshop.dev/about](https://gitworkshop.dev/about) for more details |
| 10 | 10 | ||
| @@ -12,16 +12,15 @@ see [gitworkshop.dev/ngit](https://gitworkshop.dev/ngit) and [gitworkshop.dev/ab | |||
| 12 | 12 | ||
| 13 | run from the directory of the git repository: | 13 | run from the directory of the git repository: |
| 14 | 14 | ||
| 15 | * `ngit init` signal you are this repo's maintainer accepting proposals via nostr | 15 | - `ngit init` signal you are this repo's maintainer accepting proposals via nostr |
| 16 | * `ngit send` issue commits as a proposal | 16 | - `ngit send` issue commits as a proposal |
| 17 | 17 | - `ngit list` list proposals; checkout, apply or donwload selected | |
| 18 | * `ngit list` list proposals; checkout, apply or donwload selected | 18 | - `ngit fetch` fetch download latest repository updates to allow `ngit list` usage offline |
| 19 | 19 | ||
| 20 | and when on a proposal branch: | 20 | and when on a proposal branch: |
| 21 | 21 | ||
| 22 | * `ngit push` send proposal revision | 22 | - `ngit push` send proposal revision |
| 23 | 23 | - `ngit pull` fetch and apply new proposal commits / revisions linked to branch | |
| 24 | * `ngit pull` fetch and apply new proposal commits / revisions linked to branch | ||
| 25 | 24 | ||
| 26 | ## Contributions Welcome! | 25 | ## Contributions Welcome! |
| 27 | 26 | ||
| @@ -29,4 +28,4 @@ use ngit to submit proposals! | |||
| 29 | 28 | ||
| 30 | [gitworkshop.dev/repo/ngit](https://gitworkshop.dev/repo/ngit) to report issues and see proposals | 29 | [gitworkshop.dev/repo/ngit](https://gitworkshop.dev/repo/ngit) to report issues and see proposals |
| 31 | 30 | ||
| 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 | 31 | install the tool with `cargo install ngit`, use a prebuilt binary or build from source off the master branch. |