diff --git a/README.md b/README.md index 0fd8e04..02820d4 100644 --- a/README.md +++ b/README.md @@ -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 ` + - for example, using a file named "zone.tab": `generate-timezone-json zone.tab` +2. Specify an output directory with option `--outDir`: `generate-timezone --outDir ` + +