docs: update readme, important note

This commit is contained in:
Ayo 2022-09-22 15:12:28 +02:00
parent 4cbf685bd3
commit 7db5043666

View file

@ -10,11 +10,11 @@
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`
### Gotchas *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)
1. Note that 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