Skip to content

Commit

Permalink
docs: slight improvement of the README (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
nobe4 authored May 22, 2024
1 parent 3a187cd commit 0bd950b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -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
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion internal/cmd/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}
Expand Down

0 comments on commit 0bd950b

Please sign in to comment.