aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4b60a2d..e0905e7 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,26 @@ Creates discord format relative timestamps, i.e.: `<t:1725834045:R>`
## Usage
- ./distamp m[:s]
+ ./distamp: discord relative timestamp generator
+
+ Usage: ./distamp [-h] [-a <date>] [-d <days>] [-w <weeks>] m[:s]
+
+ -h: print this help text
+ -a <date>: Absolute date (this option is exclusive, any other options will be ignored)
+ -d <days>: Number of days
+ -w <weeks>: Number of weeks
Where m is number of minutes from now and s is number of seconds from now
+## Config
+
+A DOS-style INI format configuration can be created at XDG\_CONFIG\_HOME/distamp/config.ini. Quoted values are not supported.
+
+The current supported keys are:
+
+ tz: the value must be a valid timezone (i.e. tz=Europe/Paris). This is used to calculate the proper locality of the date when using the -a flag.
+
+
## Build
To build, install hare and run: