Init document

open-weather-connector-product/README.md

@@ -0,0 +1,40 @@
+# Open Weather Connector
+
+Harness the power of freely available weather data in your applications with the Open Weather Connector! This tool streamlines access to OpenWeatherMap's comprehensive datasets, offering a wealth of valuable information within their free plan:
+
+* **Real-time weather:** Get current conditions for any location worldwide.
+* **Extended forecasts:** Plan ahead with multi-day predictions.
+* **Air quality:** Optimize user experience based on environmental factors.
+* **Geocoding:**
+	* **Address to coordinates:** Convert physical addresses to precise latitude and longitude values.
+	* **Coordinates to address:** Obtain the corresponding address for a given latitude and longitude.
+
+<br>
+
+## Demo
+
+Within the demo, users can access to retrieve comprehensive **5-day weather forecasts** for any global location. Follow these straightforward steps:
+
+1. **Precise Location Specification:** Accurately identify the desired location by entering the city name and its corresponding country code. For locations within the United States, the inclusion of the state code further refines the forecast.
+2. **Initiate Search:** Simply click the **Search** button to activate the retrieval process. The connector will efficiently retrieve and display a detailed **5-day forecast** specific to your chosen location.
+
+![Demo](images/forecast-weather-demo.png)
+
+## Setup
+
+### Application id
+The use of the Open Weather Map API is not free of charge. For development purposes there is a free version with minimal API calls. To use the connector, you must select a suitable API package via the [Open Weather Map API Developer](https://openweathermap.org/api) and generate a **api key**.
+
+##### How to get api key
+1. Login and go to your [Open Weather Map API keys page](https://home.openweathermap.org/api_keys)
+2. Add your api key name and generate it:
+![Register key](images/register-api-key.png)
+3. Api key now is available:
+![Register key](images/register-successful.png)
+
+After a **api key** is available, you can store it in your project in the variables.yaml as the variable "openWeatherConnector.appId":
+
+```
+@variables.yaml@ 
+```
+<br>