GothenburgBitFactory/timewarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/timewarrior.git synced 2025-06-26 10:54:28 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update holidays/README

Browse source 
- Add links to holidata.net
- Reformat shell command examples

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
This commit is contained in:
Thomas Lauf 2022-09-08 16:36:54 +02:00
parent f346142560
commit ce68d43305
1 changed files with 15 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

22
doc/holidays/README
View file

@ -1,27 +1,35 @@
# Timewarrior Holiday Files
The holiday files were created by the `refresh` script using data from https://holidata.net.
The holiday files can be updated using the command:
The holiday files were created by the `refresh` script using data from [holidata.net](https://holidata.net).
They can be updated using the following command:
$ ./refresh
```shell
$ ./refresh
```
This updates all present holiday files with holiday data for the current and the following year (default).
If you need another locale (for example `sv-SE`), do this:
$ ./refresh --locale sv-SE
```shell
$ ./refresh --locale sv-SE
```
This creates a file `holidays.sv-SE` containing holiday data for the current and following year.
The id for the locale is composed of the [ISO 639-1 language code](https://en.wikipedia.org/wiki/ISO_639-1) and the [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
If you need a specific locale region, do this:
$ ./refresh --locale de-CH --region BE
```shell
$ ./refresh --locale de-CH --region BE
```
For regions use the corresponding [ISO 3166-2 code for principal subdivisions](https://en.wikipedia.org/wiki/ISO_3166-2).
To specify a set of years to update, do this:
$ ./refresh --locale en-US --year 2018 2019 2020
```shell
$ ./refresh --locale en-US --year 2020 2021 2022
```
If the locale is not yet supported by holidata.net, or there is no data available for the requested year, you will see an error.
If the locale is not yet supported by [holidata.net](https://holidata.net), or there is no data available for the requested year, you will see an error.