Skip to content

Commit

Permalink
v1.0.1 README
Browse files Browse the repository at this point in the history
  • Loading branch information
hrntknr committed Jul 25, 2022
1 parent 0ea8d3f commit 76f914e
Showing 1 changed file with 46 additions and 2 deletions.
48 changes: 46 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ However, support for the backend type is poorer than ntfy.

```sh
$ # for linux
$ sudo curl -L https://github.com/hrntknr/ntf/releases/download/v0.1.9/ntf-x86_64-unknown-linux-gnu -o /usr/local/bin/ntf
$ sudo curl -L https://github.com/hrntknr/ntf/releases/download/v1.0.1/ntf-x86_64-unknown-linux-gnu -o /usr/local/bin/ntf
$ # for mac
$ # sudo curl -L https://github.com/hrntknr/ntf/releases/download/v0.1.9/ntf-x86_64-apple-darwin -o /usr/local/bin/ntf
$ # sudo curl -L https://github.com/hrntknr/ntf/releases/download/v1.0.1/ntf-x86_64-apple-darwin -o /usr/local/bin/ntf
$ sudo chmod +x /usr/local/bin/ntf

$ echo -e 'backends: ["pushover"]\npushover: {"user_key": "t0k3n"}' > ~/.ntf.yml
Expand All @@ -38,6 +38,45 @@ $ echo 'export AUTO_NTF_DONE_LONGER_THAN=10' >> ~/.bashrc
$ echo 'eval "$(ntf shell-integration)"' >> ~/.bashrc
```

```
> $ ntf --help
Usage:
[command]
Available Commands:
done Execute the command and notify the message
help Help about any command
send send notification
shell-integration shell-integration
Flags:
-h, --help help for this command
Use " [command] --help" for more information about a command.
> $ ntf send --help
send notification
Usage:
send [flags]
Flags:
--backends strings
-h, --help help for send
--line.token string
--pushbullet.token string
--pushover.device string
--pushover.expire int
--pushover.priority string
--pushover.retry int
--pushover.user_key string
--slack.color string
--slack.webhook string
--syslog.facility string
--syslog.severity string
-t, --title string override title
```

## Supported backend

### [slack: (webhook)](https://api.slack.com/messaging/webhooks)
Expand Down Expand Up @@ -111,3 +150,8 @@ syslog:
facility: 'user' #option
severity: 'emerg' #option
```

## Custom backend

You can add the custom backend you want by simply creating a struct that implements the interface in the backends folder.
Or, submit a backend request that you would like to use via Issue.

0 comments on commit 76f914e

Please sign in to comment.