diff --git a/README.md b/README.md index ba1f49f..dde7602 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,26 @@ Nixpkgs PR status checker. ## Example ```console -$ nixprstatus 345501 +$ nixprstatus pr 345501 +ktailctl: 0.18.0 -> 0.18.1 +✅ merged ✅ master -❌ nixos-unstable-small -❌ nixos-unstable +✅ nixos-unstable-small +✅ nixos-unstable ❌ nixos-24.05 + +$ nixprstatus --help +Usage: python -m nixprstatus [OPTIONS] COMMAND [ARGS]... + +Options: + --install-completion Install completion for the current shell. + --show-completion Show completion for the current shell, to copy it or + customize the installation. + --help Show this message and exit. + +Commands: + pr Get merge status of pull request. + since Return the count of commits that has happened between the two refs. ``` -## TODO - -* Support backported commits -* JSON output diff --git a/nixprstatus/__main__.py b/nixprstatus/__main__.py index c2d3921..b3c88fa 100644 --- a/nixprstatus/__main__.py +++ b/nixprstatus/__main__.py @@ -21,7 +21,7 @@ def pr( list[str] | None, typer.Option(help="Check specific branch") ] = None, ): - """Get status of pull request""" + """Get merge status of pull request.""" console = Console() if branches: