Skip to content

Commit ecc5e8f

Browse files
committed
Modify some sentences about ntfy feature
1 parent 9bcc4af commit ecc5e8f

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Use the following settings to update cell execution time for a notification and
9090
"minimum_cell_execution_time": 60,
9191

9292
// Notification Methods
93-
// Methods how to notificate messages. Select from 'browser' or 'ntfy'
93+
// Option to send a notification with the specified method(s). The available options are 'browser' and 'ntfy'.
9494
"notification_methods": [
9595
"browser"
9696
],
@@ -108,22 +108,24 @@ Use the following settings to update cell execution time for a notification and
108108

109109
![notification](https://user-images.githubusercontent.com/3497137/111881088-01db5200-897d-11eb-8faa-4701cabfcde4.gif)
110110

111-
## (Option) Notifications using `ntfy`
111+
## (Optional) Notifications using `ntfy`
112112

113113
You can recieve notifications via `ntfy`.
114114

115115
**ntfy 2.7.0 documentation** https://ntfy.readthedocs.io/en/latest/
116116

117-
> ntfy brings notification to your shell. It can automatically provide desktop notifications when long running commands finish or it can send push notifications to your phone when a specific command finishes.
117+
> ntfy brings notification to your shell. It can automatically provide desktop notifications when long running code executions finish or it can send push notifications to your phone when a specific execution finishes.
118118
119-
### How to work
119+
### How to enable notifications via `ntfy`
120120

121121
Install `ntfy`.
122122

123123
```console
124124
$ pip install ntfy
125125
```
126-
Configure ntfy in accodance with [the ntfy official document](https://ntfy.readthedocs.io/en/latest/#configuring-ntfy)
126+
To configure ntfy, please check out [the ntfy official configuration docs](https://ntfy.readthedocs.io/en/latest/#configuring-ntfy)
127+
128+
For example, if your OS is Linux and you want to select `pushover` for the backend, set configuration as follows.
127129

128130
```console
129131
$ vim ~/.config/ntfy/ntfy.yml
@@ -133,7 +135,7 @@ $ vim ~/.config/ntfy/ntfy.yml
133135
backends:
134136
- pushover
135137
pushover:
136-
user_key: hunter2
138+
user_key: YOUR_PUSHOVER_USER_KEY
137139
```
138140
139141
Change the notifications [settings](#settings). Append `"ntfy"` into `notification_methods` attribute.

0 commit comments

Comments
 (0)