diff --git a/README.md b/README.md index 4e5f77b..6e0c56b 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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) @@ -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.