diff --git a/README.md b/README.md index 79eaf0e..cd04493 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# `gh-not` +# `gh-not` 🔕 -> GitHub rule-based notifications managements +> GitHub rule-based notifications management -# Installation +# Install - Download a binary from the [release page.](https://github.com/nobe4/gh-not/releases/latest) @@ -11,6 +11,9 @@ gh extension install nobe4/gh-not ``` + Is used with `gh not`, while the others `gh-not`. The documentation uses + `gh-not` exclusively. + - Install via `go`: ```shell go install github.com/nobe4/gh-not/cmd/gh-not@latest @@ -22,7 +25,20 @@ go build ./cmd/gh-not ``` -# Configuration +# Run + +```shell +gh-not --help +gh-not sync +gh-not list --filter '.author.login | contains("4")' +... +``` + +# Configure + +> [!NOTE] +> The tool requires a config file to exist for it to run, that's unfortunate and +> will be fixed soon. The configuration file contains the rules to apply to the notifications. Each rule contains three fields: diff --git a/internal/cmd/list.go b/internal/cmd/list.go index 10c01df..31da200 100644 --- a/internal/cmd/list.go +++ b/internal/cmd/list.go @@ -18,7 +18,7 @@ var ( Short: "List notifications", Example: ` gh-not list - gh-not list --filter ''.author.login | contains("4")' + gh-not list --filter '.author.login | contains("4")' `, RunE: runList, }