diff options
| author | DanConwayDev <DanConwayDev@protonmail.com> | 2024-11-27 10:26:14 +0000 |
|---|---|---|
| committer | DanConwayDev <DanConwayDev@protonmail.com> | 2024-11-27 10:26:14 +0000 |
| commit | dcbf4b83bcc1318bc2a328de96b9cd63ed6dc771 (patch) | |
| tree | c85924da5264cd3bbd788cd42c7c1ecf87e9acce | |
| parent | ef552c12a6604c4b834f80b68c342d7f9668aa4b (diff) | |
feat(login): tweak api description
to add clarity and use PR instead of proposal
| -rw-r--r-- | README.md | 15 | ||||
| -rw-r--r-- | src/bin/ngit/cli.rs | 6 |
2 files changed, 8 insertions, 13 deletions
| @@ -52,19 +52,14 @@ eg self-hosted, github, codeberg, etc. | |||
| 52 | 52 | ||
| 53 | run from the directory of the git repository: | 53 | run from the directory of the git repository: |
| 54 | 54 | ||
| 55 | - `ngit init` signal you are this repo's maintainer accepting proposals via nostr | 55 | - `ngit init` signal you are this repo's maintainer accepting PRs and issues via nostr |
| 56 | - `ngit send` issue commits as a proposal | 56 | - `ngit send` submit PR with advanced options |
| 57 | - `ngit list` list proposals; checkout, apply or donwload selected | 57 | - `ngit list` list Prs; checkout, apply or donwload selected |
| 58 | - `ngit fetch` fetch download latest repository updates to allow `ngit list` usage offline | 58 | - `ngit account` login, logout, export keys |
| 59 | |||
| 60 | and when on a proposal branch: | ||
| 61 | |||
| 62 | - `ngit push` send proposal revision | ||
| 63 | - `ngit pull` fetch and apply new proposal commits / revisions linked to branch | ||
| 64 | 59 | ||
| 65 | ## contributions welcome! | 60 | ## contributions welcome! |
| 66 | 61 | ||
| 67 | use ngit to submit proposals! | 62 | use ngit to submit PRs! |
| 68 | 63 | ||
| 69 | [gitworkshop.dev/r/naddr1qqzxuemfwsq3gamnwvaz7tmjv4kxz7fwv3sk6atn9e5k7q3q5qydau2hjma6ngxkl2cyar74wzyjshvl65za5k5rl69264ar2exsxpqqqpmejawq4qj](https://gitworkshop.dev/repo/ngit) to report issues and see proposals | 64 | [gitworkshop.dev/r/naddr1qqzxuemfwsq3gamnwvaz7tmjv4kxz7fwv3sk6atn9e5k7q3q5qydau2hjma6ngxkl2cyar74wzyjshvl65za5k5rl69264ar2exsxpqqqpmejawq4qj](https://gitworkshop.dev/repo/ngit) to report issues and see proposals |
| 70 | 65 | ||
diff --git a/src/bin/ngit/cli.rs b/src/bin/ngit/cli.rs index 3a5b4e7..cb50730 100644 --- a/src/bin/ngit/cli.rs +++ b/src/bin/ngit/cli.rs | |||
| @@ -53,11 +53,11 @@ pub fn extract_signer_cli_arguments(args: &Cli) -> Result<Option<SignerInfo>> { | |||
| 53 | 53 | ||
| 54 | #[derive(Subcommand)] | 54 | #[derive(Subcommand)] |
| 55 | pub enum Commands { | 55 | pub enum Commands { |
| 56 | /// signal you are this repo's maintainer accepting proposals via nostr | 56 | /// signal you are this repo's maintainer accepting PRs and issues via nostr |
| 57 | Init(sub_commands::init::SubCommandArgs), | 57 | Init(sub_commands::init::SubCommandArgs), |
| 58 | /// issue commits as a proposal | 58 | /// submit PR with advanced options |
| 59 | Send(sub_commands::send::SubCommandArgs), | 59 | Send(sub_commands::send::SubCommandArgs), |
| 60 | /// list proposals; checkout, apply or download selected | 60 | /// list PRs; checkout, apply or download selected |
| 61 | List, | 61 | List, |
| 62 | /// login, logout or export keys | 62 | /// login, logout or export keys |
| 63 | Account(AccountSubCommandArgs), | 63 | Account(AccountSubCommandArgs), |