aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJozanLeClerc <bousset.rudy@gmail.com>2019-11-15 11:27:50 +0100
committerJozanLeClerc <bousset.rudy@gmail.com>2019-11-15 11:27:50 +0100
commitafdce8d838139beec3c2acb85a5ce22cfd56a5ac (patch)
treefd62aa39319ebb25e472ab05e7ade701eae9f943
parentREADME update (diff)
downloadlowbat-gnu-afdce8d838139beec3c2acb85a5ce22cfd56a5ac.tar.gz
lowbat-gnu-afdce8d838139beec3c2acb85a5ce22cfd56a5ac.tar.bz2
lowbat-gnu-afdce8d838139beec3c2acb85a5ce22cfd56a5ac.tar.xz
lowbat-gnu-afdce8d838139beec3c2acb85a5ce22cfd56a5ac.tar.zst
lowbat-gnu-afdce8d838139beec3c2acb85a5ce22cfd56a5ac.zip
README finished
-rw-r--r--README.md23
1 files changed, 21 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9949100..5a7adb8 100644
--- a/README.md
+++ b/README.md
@@ -26,9 +26,28 @@ lowbat > /dev/null 2>&1 &
## Options
-Two options are available.
+Two options are available:
+
++ `--say [MESSAGE]`
++ `--silent`
+
+### Definitions
+
+`--say "message"` will allow you to set your own warning message lowbat is active.
+
+#### Example:
+
```shell
-lowbat --say ""
+lowbat --say "your custom message" > /dev/null 2>&1
+```
+
+`--silent` disables audio warnings.
+
+#### Example:
+
+```shell
+lowbat --silent > /dev/null 2>&1
+```
## Uninstallation