From 424badba84c9f7e50e4f85a44a332e4dd85e61a1 Mon Sep 17 00:00:00 2001 From: Ayo Date: Thu, 22 Sep 2022 15:16:32 +0200 Subject: [PATCH] docs: update instructions: --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dcb278f..51a9ed3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # Generate Timezone JSON ### 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 @@ -10,11 +12,14 @@ 1. Run: `npx generate-timezone-json ` to generate timezones.json from a TAB file, - 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) ### Planned features (not yet implemented) 1. Specify an output directory with option `--outDir`: `generate-timezone --outDir ` 2. Uniform JSON structure for all sources +3. type definitions