Skip to content

Commit 6b025ba

Browse files
committed
docs: update README
1 parent 3d6853c commit 6b025ba

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
> Generate ical (.ics) files from date-holidays data
44
55
[![NPM version](https://badge.fury.io/js/date-holidays-ical.svg)](https://www.npmjs.com/package/date-holidays-ical/)
6-
[![Build Status](https://github.com/commenthol/date-holidays-ical/workflows/CI/badge.svg?branch=master&event=push)](https://github.com/commenthol/date-holidays-ical/actions/workflows/ci.yml?query=branch%3Amaster)
7-
6+
[![Build Status](https://github.com/commenthol/date-holidays-ical/actions/workflows/ci.yml/badge.svg)](https://github.com/commenthol/date-holidays-ical/actions/workflows/ci.yml)
87

98
This tool exports data from [date-holidays][] into iCal format.
109

@@ -15,14 +14,16 @@ This tool exports data from [date-holidays][] into iCal format.
1514
1615
Options:
1716
18-
-h, --help output usage information
19-
-V, --version output the version number
20-
-o, --out <file> write to file
21-
-y, --year <year> year
22-
-f, --fullday ical events are per full day
23-
-s, --showcode show country code in each ical summary
24-
-n, --name <name> instead of country code add your own name to each ical summary
25-
-q, --query query for available countries, states, regions by shortcode
17+
-h, --help this help
18+
-v, --version display version
19+
-o, --out file write to file
20+
-y, --year year year or year range
21+
-f, --fullday ical events are per full day
22+
-s, --showcode show country code in each ical summary
23+
-t, --transp ical events are all transparent
24+
-n, --name name instead of country code add your own name to each ical summary
25+
-q, --query query for available countries, states, regions by shortcode
26+
-l, --language language set language
2627
2728
Examples:
2829
@@ -34,6 +35,9 @@ This tool exports data from [date-holidays][] into iCal format.
3435
3536
Calender for 2017 New Zealand, Auckland Province:
3637
$ holiday-ical -f -y 2017 NZ.au
38+
39+
Calender for 2017 - 2019 New Zealand Auckland Province:
40+
$ holiday-ical -f -y 2017-2019 NZ.au
3741
```
3842

3943
Import the generated file into your calendar tool of choice.

0 commit comments

Comments
 (0)