Skip to content

Commit b70a52f

Browse files
authored
readme: update info
Add an command-line arguments section Fix some grammer
1 parent f13a3d8 commit b70a52f

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,15 @@
6060
<li><a href="#building-from-source">Building from Source</a></li>
6161
</ul>
6262
</li>
63-
<li><a href="#usage">Usage</a></li>
63+
<li>
64+
<a href="#usage">Usage</a>
65+
<ul>
66+
<li><a href="#command-line-arguments">Command-line arguments</a></li>
67+
<li><a href="#examples">Examples</a></li>
68+
<li><a href="#custom-hints">Custom Hints</a></li>
69+
<li><a href="#note-about-replace-id">Note about `replace-id`</a></li>
70+
</ul>
71+
</li>
6472
<li><a href="#roadmap">Roadmap</a></li>
6573
<li><a href="#contributing">Contributing</a></li>
6674
<li><a href="#license">License</a></li>
@@ -156,13 +164,27 @@ Execute the daemon:
156164
```sh
157165
hyprnotify
158166
```
167+
### Command-line arguments
168+
| Argument | Remark |
169+
|:-------------------:|:--------------------------------------------:|
170+
|`--font-size` or `-f`| Set custom default font size (default is 13) |
171+
|`--fixed-font-size` | Ignores font size hints |
172+
|`--no-sound` or `-s` | Enable silent mode |
173+
|`--help` | Displays help text |
174+
175+
> [!IMPORTANT]
176+
> It is recommended to set the Hyprland default `font-family` to be `monospace` on hyprland.conf misc section. Otherwise you may experience unusual spacing and padding. See here: https://wiki.hyprland.org/Configuring/Variables/#misc
159177
160178
### Examples
161179

162180
Send a notification:
163181
```sh
164182
notify-send "Hello, World!"
165183
```
184+
Send a notification with body text:
185+
```sh
186+
notify-send "Chat?" "Is this real"
187+
```
166188
Add a font-size hint:
167189
```sh
168190
notify-send "This is very big!" -h int:x-hyprnotify-font-size:40
@@ -172,8 +194,8 @@ Add an urgency hint and last for 20 seconds:
172194
notify-send "This is serious stuff!" -u critical -t 20000
173195
```
174196
### Custom Hints
175-
| Hint | Example | Comment |
176-
|:-----------------------:|:-----------------------------------:|:---------------------------------|
197+
| Hint | Example | Remark |
198+
|:-----------------------:|:-----------------------------------:|:--------------------------------:|
177199
| `x-hyprnotify-font-size`| `int:x-hyprnotify-font-size:30` | font size for notification |
178200
| `x-hyprnotify-color` | `string:x-hyprnotify-color:#ff30fa` | hex color code for notif. color |
179201
| `x-hyprnotify-icon` | `int:x-hyprnotify-icon:3` | icon identifier for notification |
@@ -189,21 +211,12 @@ notify-send "This is serious stuff!" -u critical -t 20000
189211
|`4` |CONFUSED|![CONFUSED](https://github.com/codelif/hyprnotify/assets/68972644/64ae100b-dc2c-46dd-be8c-afdacb03042b)|
190212
|`5` |OK |![OK](https://github.com/codelif/hyprnotify/assets/68972644/2b66a258-5e07-4683-a798-fe6f47d67716)|
191213

192-
### Audio Playback
193-
A notification sound is played along with a notification.
194-
195-
To disable this behaviour pass `--silent` flag when executing.
196-
```sh
197-
hyprnotify --silent
198-
```
199-
`--no-sound` and `-s` also works the same way.
200-
201214
### Note about `replace-id`:
202215
When using `replace-id` with `notify-send`
203216
```sh
204217
notify-send --replace-id=10 "Hello"
205218
```
206-
All the notifications with IDs of more than `replace-id` will also be deleted. (11, 12, 13...) \
219+
All the notifications with IDs more than `replace-id` will also be deleted. (11, 12, 13...) \
207220
This is due to the inherent design of `hyprctl dismissnotify`. So, it is not fixable.\
208221
\
209222
Due to this, it is advisable to use it to replace only the latest notification.

0 commit comments

Comments
 (0)