ayo/generate-timezone-json
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update README

Browse source
This commit is contained in:
Ayo 2022-09-19 12:02:48 +02:00
parent eb9a58de47
commit 941641ce8b
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -2,3 +2,16 @@
### Installation
`npm i generate-timezone-json`
### Usage
1. Run: `generate-timezone-json` to generate timezones.json from official IANA Database,
- this will generate a file named "timezones.json" with data coming from the official IANA database
### Planned features (not yet implemented)
1. To generate timezones.json from a TAB file, run: `generate-timezone-json <filename>`
- for example, using a file named "zone.tab": `generate-timezone-json zone.tab`
2. Specify an output directory with option `--outDir`: `generate-timezone <filename> --outDir <directory>`