From 9632349a85fd53bc5af272d3539d38030567412b Mon Sep 17 00:00:00 2001 From: DanConwayDev Date: Wed, 27 Nov 2024 11:48:05 +0000 Subject: build: add description to help and add `ngit init` to description / help content --- Cargo.toml | 2 +- README.md | 3 ++- src/bin/git_remote_nostr/main.rs | 1 + src/bin/ngit/cli.rs | 6 +++++- 4 files changed, 9 insertions(+), 3 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index b89087d..8ed3741 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ name = "ngit" version = "1.5.3" edition = "2021" -description = "a command-line tool and git plugin to work with nostr enabled git repositories" +description = "nostr plugin for git" authors = ["DanConwayDev "] readme = "README.md" homepage = "https://gitworkshop.dev/r/naddr1qqzxuemfwsqs6amnwvaz7tmwdaejumr0dspzpgqgmmc409hm4xsdd74sf68a2uyf9pwel4g9mfdg8l5244t6x4jdqvzqqqrhnym0k2qj" diff --git a/README.md b/README.md index 5f75ab5..6117ada 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # ngit -a command-line tool and git plugin to work with nostr enabled git repositories +nostr plugin for git - clone a nostr repository, or add as a remote, by using the url format nostr://pub123/identifier - remote branches begining with `pr/` are open PRs from contributors; `ngit list` can be used to view all PRs - to open a PR, push a branch with the prefix `pr/` or use `ngit send` for advanced options +- publish a repository to nostr with `ngit init` browse [gitworkshop.dev/repos](https://gitworkshop.dev/repos) to find nostr repositories. diff --git a/src/bin/git_remote_nostr/main.rs b/src/bin/git_remote_nostr/main.rs index 6b89be6..f164a65 100644 --- a/src/bin/git_remote_nostr/main.rs +++ b/src/bin/git_remote_nostr/main.rs @@ -131,6 +131,7 @@ fn process_args() -> Result> { println!( " - to open a PR, push a branch with the prefix `pr/` or use `ngit send` for advanced options" ); + println!("- publish a repository to nostr with `ngit init`"); return Ok(None); }; diff --git a/src/bin/ngit/cli.rs b/src/bin/ngit/cli.rs index e537197..26116be 100644 --- a/src/bin/ngit/cli.rs +++ b/src/bin/ngit/cli.rs @@ -5,7 +5,11 @@ use ngit::login::SignerInfo; use crate::sub_commands; #[derive(Parser)] -#[command(author, version, about, long_about = None)] +#[command( + author, + version, + help_template = "{name} {version}\nnostr plugin for git\n - clone a nostr repository, or add as a remote, by using the url format nostr://pub123/identifier\n - remote branches begining with `pr/` are open PRs from contributors; `ngit list` can be used to view all PRs\n - to open a PR, push a branch with the prefix `pr/` or use `ngit send` for advanced options\n- publish a repository to nostr with `ngit init`\n\n{usage}\n{all-args}" +)] #[command(propagate_version = true)] pub struct Cli { #[command(subcommand)] -- cgit v1.2.3