feat(package): 📝 updated README.md + added post-install script

v1.0.0 should be ready to release now

README.md

@@ -4,6 +4,8 @@ Retrieve weather information directly from your terminal.
 
 ![terminal example usage](terminal.gif)
 
+![3 day forecast preview](table_forecast.png)
+
 # Install
 via `npm`
 ```
@@ -77,23 +79,98 @@ You can show the current config with following command:
 ```
 weather -c
 ```
-The config allows you to change the temperature unit.
+The config allows you to change the temperature unit, the forecast hour traversing style, the favorite location and the default action for blank command.
 ```
 weather -c
 # output
 ? Select config option » - Use arrow-keys. Return to submit.
     Show API key
     Delete API key
 >   Set temperature unit
+    Set forecast hour traversing style
+    Preset Times Configuration
+    Set favorite location
+    Set default action for blank command
+    Reset config
     Cancel
     ---
-    √ Select config option » Set temperature unit
-    ---
 ? Select temperature unit » - Use arrow-keys. Return to submit.
 >   Celsius
     Fahrenheit
     ---
     √ Select temperature unit » Celsius
     ---
 Temperature unit is saved as metric.
-```
+```
+
+## Temperature unit
+The two options for temperature unit are Celsius (metric) and Fahrenheit (imperial). Every temperature will be converted to the selected unit when displayed.
+You can change the temperature unit in the config (`weather -c`). The default unit is Celsius.
+
+## Forecast hour traversing style
+When checking forecast information, you can choose between two hour traversing styles. The default one (dial) lets you cycle the forecast for each hour individually (0-23) when accessing a forecast. The other style (preset) lets you configure a list of preset times which will be used to check the forecast. You can change the hour traversing style in the config (`weather -c`). The default style is dial. The default preset options are Morning (6 AM), Noon (12 PM), Evening (6 PM) and Night (12 AM). You are also able to configure these presets in the configuration.
+For example:
+```
+weather -c
+# output
+? Select config option » - Use arrow-keys. Return to submit.
+    Show API key
+    Delete API key
+    Set temperature unit
+    Set forecast hour traversing style
+>   Preset Times Configuration
+    Set favorite location
+    Set default action for blank command
+    Reset config
+    Cancel
+    ---
+? Choose an option » - Use arrow-keys. Return to submit.
+>   Add preset time
+    Edit preset time
+    Remove preset times
+    Show preset times
+    Reset preset times
+    Cancel
+    ---
+    ? Enter a preset name » Afternoon
+    ---
+    √ Enter a preset name ... Afternoon
+    ? Enter a preset time » 16
+    Preset time added.
+```
+You can also show the preset times like this:
+```
+weather -c
+# output
+√ Select config option » Preset Times Configuration     
+? Choose an option » - Use arrow-keys. Return to submit.
+    Add preset time
+    Edit preset time
+    Remove preset times
+>   Show preset times
+    Reset preset times
+    Cancel
+    ---
+    √ Choose an option » Show preset times
+    ╔═══════════╤══════╗
+    ║ Name      │ Time ║
+    ╟───────────┼──────╢
+    ║ Night     │ 0    ║
+    ╟───────────┼──────╢
+    ║ Morning   │ 6    ║
+    ╟───────────┼──────╢
+    ║ Noon      │ 12   ║
+    ╟───────────┼──────╢
+    ║ Afternoon │ 16   ║
+    ╟───────────┼──────╢
+    ║ Evening   │ 18   ║
+    ╚═══════════╧══════╝
+```
+You are also able to edit and remove existing preset times as well as resetting them to their default state.
+
+## Favorite location
+You can set a favorite location in the config (`weather -c`). This location will be used when you don't specify a location in the command. The default location is Munich.
+
+## Default action for blank command
+You can set a default action for the blank command (`weather`) in the config (`weather -c`). The default action is to show a three day forecast for the favorite location.
+However, you can set the default action to show the full prompt menu for the favorite location instead.

bin/configHandler.js

@@ -32,7 +32,7 @@ export const configHandler = async noclear => {
       { title: "Preset Times Configuration", value: "preset" },
       { title: "Set favorite location", value: "location"},
       { title: "Set default action for blank command", value: "default"},
-      { title: "Clear config", value: "clear" },
+      { title: "Reset config", value: "reset" },
       { title: "Cancel", value: "cancel" },
     ],
   });
@@ -48,7 +48,7 @@ export const configHandler = async noclear => {
     await setUnit();
     await recall(true);
   }
-  if (response.config === "clear") {
+  if (response.config === "reset") {
     await clearConfig();
     await recall(true);
   }
@@ -127,7 +127,7 @@ const setUnit = async () => {
 };
 
 const clearConfig = async () => {
-  await config.clear();
+  await config.reset();
   console.log(chalk.green("Config cleared."));
 };
 

bin/index.js

@@ -85,6 +85,7 @@ const options = getopts(argv, {
     env: "e",
     fast: "f",
     three_day: "t",
+    prompt: "p",
     info: "i",
   },
 });
@@ -108,6 +109,7 @@ if (options.help) {
         -e, --env               set api key from environment variable API_KEY
         -f , --fast [loc]       fast mode, no prompt, location as arg
         -t, --three_day [loc]   show three day forecast
+        -p, --prompt [loc]      prompt mode (default when using blank command with location as arg)
         -i, --info              show project related info
 
     Examples:
@@ -201,6 +203,15 @@ if (options.config) {
   } else {
     console.log(chalk.red("You need to specify a location."));
   }
+} else if (options.prompt) {
+  // prompt for location
+  console.clear();
+  if (argv.length > 1) {
+    argv.shift();
+    weatherprompt(argv.join(" "));
+  } else {
+    weatherprompt();
+  }
 } else {
   // prompt for location
   console.clear();

bin/post-install.js

@@ -0,0 +1,14 @@
+import chalk from "chalk";
+
+import gradient from "gradient-string";
+
+import terminalLink from "terminal-link";
+
+console.log(gradient.pastel("Thank you for installing Weather CLI!\nTo start things off, you need to set your API key."));
+const link = terminalLink("Weather API", "https://www.weatherapi.com/");
+console.log(gradient.pastel("In order to retrieve your API key, you need to set up an account on " + link + " if not done already."));
+console.log(gradient.pastel("Once you have your API key, run ") + chalk.green("weather --config") + gradient.mind(" and follow the instructions."));
+
+console.log(chalk.cyan("You can always check the " + chalk.magenta.bgBlue("README.md") + " file for more information."));
+const repository = terminalLink("GitHub repository", "https://www.github.com/suptower/weather-cli");
+console.log(chalk.cyan("If you have any questions or suggestions, feel free to open an issue on the " + chalk.magenta(repository) + "."));

package.json

@@ -1,15 +1,16 @@
 {
 	"name": "@suptower/weather-cli",
 	"version": "0.5.2",
-	"date": "Updated on 7th of August 2023.",
+	"date": "Updated on 8th of August 2023.",
 	"description": "A package to retrieve weather information directly from your terminal.",
 	"exports": "./bin/index.js",
 	"type": "module",
 	"scripts": {
 		"release": "node ./bin/autodate.js && commit-and-tag-version",
 		"lint": "prettier --check . && eslint .",
 		"lint:fix": "prettier --write . && eslint . --fix",
-		"autodate": "node ./bin/autodate.js"
+		"autodate": "node ./bin/autodate.js",
+		"postinstall": "node ./bin/post-install.js"
 	},
 	"bin": {
 		"weather": "./bin/index.js"
@@ -60,9 +61,10 @@
 		"ora": "^6.3.1",
 		"prompts": "^2.4.2",
 		"string-length": "^6.0.0",
-		"table": "^6.8.1"
+		"table": "^6.8.1",
+		"terminal-link": "^3.0.0"
 	},
 	"engines": {
 		"node": ">=16"
 	}
-}
+}