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

docs: update instructions:

Browse source
This commit is contained in:
Ayo 2022-09-22 15:16:32 +02:00
parent 7db5043666
commit 424badba84
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -1,7 +1,9 @@
# Generate Timezone JSON # Generate Timezone JSON
### Installation ### Installation
`npm i generate-timezone-json` Run `npm i generate-timezone-json` to install in your current node project
or install globally with `npm i -g generate-timezone-json`
### Usage ### Usage
@ -10,11 +12,14 @@
1. Run: `npx generate-timezone-json <filename>` to generate timezones.json from a TAB file, 1. Run: `npx generate-timezone-json <filename>` to generate timezones.json from a TAB file,
- for example, using a file named "zone.tab": `generate-timezone-json zone.tab` - for example, using a file named "zone.tab": `generate-timezone-json zone.tab`
If installed globally, the `npx` is optional.
*Important Note:* the structure of the generated JSON file will be different depending on the source (i.e, zone.tab or the IANA timezones database) *Important Note:* the structure of the generated JSON file will be different depending on the source (i.e, zone.tab or the IANA timezones database)
### Planned features (not yet implemented) ### Planned features (not yet implemented)
1. Specify an output directory with option `--outDir`: `generate-timezone <filename> --outDir <directory>` 1. Specify an output directory with option `--outDir`: `generate-timezone <filename> --outDir <directory>`
2. Uniform JSON structure for all sources 2. Uniform JSON structure for all sources
3. type definitions