From dcaa3450430fec7ce23c4ed4f0b9fd480324d1ed Mon Sep 17 00:00:00 2001 From: Julian Hurst Date: Thu, 31 Oct 2024 21:31:57 +0100 Subject: Update README.md and punctuation --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'README.md') 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.: `` ## Usage - ./distamp m[:s] + ./distamp: discord relative timestamp generator + + Usage: ./distamp [-h] [-a ] [-d ] [-w ] m[:s] + + -h: print this help text + -a : Absolute date (this option is exclusive, any other options will be ignored) + -d : Number of days + -w : 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: -- cgit v1.2.3