Merge branch 'release/v1.5'

Author: pazurkota

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contribution Guidelines
+Thank you for your interest in contributing to the project! We appreciate your help in making this simple weather checking command-line tool even better. To ensure a smooth collaboration, please follow these guidelines when contributing to the project.
+
+### Getting Started
+To contribute to this project, follow these steps:
+
+1. Fork the repository on GitHub.
+2. Clone the forked repository to your local machine.
+3. Make the necessary changes and improvements to the codebase.
+4. Test your changes to ensure they work as expected.
+5. Commit your changes with clear and descriptive commit messages.
+6. Push the changes to your forked repository.
+7. Submit a pull request to the main repository.
+
+### Code Guidelines
+Please adhere to the following code guidelines:
+
+- Write clear and concise code that is easy to understand and maintain.
+- Follow the existing coding style and conventions used in the project.
+- Use meaningful variable and function names that accurately describe their purpose.
+- Comment your code when necessary, especially for complex logic or non-obvious functionality.
+
+### Testing
+To maintain the project's quality, it is essential to test your changes. Here's how you can test the project:
+
+- Run the existing tests to ensure that the project functions as expected.
+- Write additional tests to cover the new features or changes you made.
+- Ensure that all tests pass successfully before submitting your changes.
+
+### Documentation
+If you make changes that require updates to the documentation, please make sure to update the relevant parts of the project's documentation. This includes the README file, inline code comments, and any other relevant documentation files.
+
+### Issue Tracking
+If you find any bugs, have suggestions, or would like to request new features, please create an issue in the GitHub repository. Make sure to provide a clear and detailed description of the problem or enhancement you are proposing.
+
+### Pull Request Process
+To contribute your changes back to the main project, please follow these steps:
+
+1. Ensure that your forked repository is up to date with the latest changes from the main repository.
+2. Create a new branch for your changes, with a descriptive name.
+3. Make your changes and commit them with clear and concise messages.
+4. Push your branch to your forked repository.
+5. Open a pull request from your branch to the main repository.
+6. Provide a detailed description of the changes you made and the motivation behind them.
+7. Wait for feedback and address any requested changes if necessary.
+8. Once approved, your changes will be merged into the main repository.
+
+### Conclusion
+Thank you for considering contributing to this project! Your help is greatly appreciated. Let's work together to make this weather checking command-line tool even more useful and efficient. If you have any questions, feel free to reach out by creating an issue or contacting the project maintainers. Happy coding!

README.md

@@ -17,13 +17,13 @@ Console Weather project is a simple application project to check weather in cons
 ## Installation
 
 If you installed [.NET 7.0 or newer](https://dotnet.microsoft.com/en-us/download), just simply paste this command into console:
-```bash
-dotnet tool install --global console-weather --version 1.4.0
+```console
+$ dotnet tool install --global console-weather --version 1.5.0
 ```
 
 If you want to update, just type:
-```bash
-dotnet tool update --global console-weather
+```console
+$ dotnet tool update --global console-weather
 ```
 
 If you running app first time, it will ask you for the [Weather API](https://www.weatherapi.com/):
@@ -38,88 +38,62 @@ Enter your personal API key and enjoy using it!
 
 The key is kept in `C:\Users\USERNAME\Documents\weather_data`
 ## Usage
-To use application, just simply type:
-```bash
-weather
-```
-To get weather info from a specified city, type:
 ```bash
-weather -c "City Name"
-```
+# To use aplication, type:
+$ weather
 
-To get weather information without alerts, type:
-```bash
-weather --no-alerts
-```
+# To get weather info from a specified city, type:
+$ weather -c "Warsaw"
 
-To get forecast for the next day, type:
-```bash
-weather -f
-```
+# To get weather information without alerts, type:
+$ weather --no-alerts
 
-To use specific units, type:
-```bash
-weather -u
-```
+# To get forecast for the next day, type:
+$ weather -f
 
-To get air quality data, type:
-```bash
-weather -a
-```
+# To use specific units, type:
+$ weather -u Si
 
-Full command list:
-```bash
-  -c, --city <city>          Get city name [optional]
-  --no-alerts                Hide weather alerts [default: False]
-  -f, --forecast             Show weather forecast [default: False]
-  -u, --units <Eu|Si|Uk|Us>  Set weather units [default: Eu]
-  -a, --air-quality          Show air quality [default: False]
-  --version                  Show version information
-  -?, -h, --help             Show help and usage information
+# To get air quality data, type:
+$ weather -a
 ```
 
 ## Demo
-
-### Weather:
-Example input:
-``` 
-weather -c "Kansas City" -f -u Si
-```
-
-Example output:
-```
-Current weather for Kansas City in United States of America is Mist
-The temperature is 17,2°C, but feels like 17,2°C
-
-Current Wind Speed is 3,1 m/s ESE
-Current Air Pressure is 1009,0 mbar
-Current Humidity is 93%
-Current Cloud Cover is 100%
-Last Update: 2023-05-06 06:45
-
-Tomorrow it will be Partly cloudy
-The temperature range will be around 14,8°C to 32,7°C, with average of 23,1°C
-The maximum wind speed will be around 8,1 m/s
-The chance of rain/snow: 0% / 0%
-```
-
-### Air Quality:
-Example input:
-```
-weather -c "Kansas City" -a
-```
-
-Example output:
-```
-Current Air Quality for Kansas City in United States of America:
-
-Carbon Monoxide: 240,30 ug/m3
-Nitrogen Dioxide: 6,40 ug/m3
-Ozone: 34,0 ug/m3
-Sulphur Dioxide: 0,30 ug/m3
-Fine Particles Matter: 5,80 ug/m3
-Coarse Particles Matter: 6,90 ug/m3
-US Epa Index: 1 (Good)
+```bash
+# Show weather for London with forecast and air quality data
+$ weather -c "London" -f -a
+
+# CURRENT WEATHER:
+# Current weather for London in United Kingdom is Partly cloudy
+# The temperature is 19,0°C, but feels like 19,0°C
+#
+# Current Wind Speed: 22,0 kph (NE)
+# Current Air Pressure: 1024,0 mbar
+# Current Visibility: 10,0 kilometers
+# Current Precipitation: 0,0 mm
+# Current Humidity: 46%
+# Current Cloud Cover: 50%
+# Current UV Index: 5,0 (Moderate)
+
+# FORECAST:
+# Tomorrow it will be Cloudy
+# Temperature Range: 7,9°C - 17,7°C (average: 13,2)°C
+# Maximum Wind Speed: 19,8 kph
+# Average Visibility: 10,0 kilometers
+# Maximum Precipitation: 0,0 mm
+# UV Index: 3,0 (Moderate)
+# Chance of rain/snow: 0% / 0%
+#
+# AIR QUALITY:
+# Carbon Monoxide: 205,30 ug/m3
+# Nitrogen Dioxide: 4,40 ug/m3
+# Ozone: 113,0 ug/m3
+# Sulphur Dioxide: 3,30 ug/m3
+# Fine Particles Matter: 4,40 ug/m3
+# Coarse Particles Matter: 7,5 ug/m3
+# US Epa Index: 1 (Good)
+# 
+# Last Update: 2023-05-20 14:45
 ```
 
 ## Acknowledgements

console-weather/Program.cs

@@ -55,9 +55,7 @@ public static async Task<int> Main(string[] args) {
     }
 
     private static void OnHandle(string cityName, bool showAlerts, bool showForecast, Units.UnitType units, bool airQuality) {
-        cityName ??= "auto:ip";
-        
-        CityName = cityName;
+        CityName = cityName ?? "auto:ip";
         DontShowAlerts = showAlerts;
         ShowForecast = showForecast;
         Settings.Units = units;