From 1c4c9d79158f925e19056273479843840e014aa5 Mon Sep 17 00:00:00 2001 From: ndkhanh-axonivy Date: Mon, 18 Mar 2024 20:25:46 +0700 Subject: [PATCH] Handle feedback of document --- open-weather-connector-product/README.md | 26 +++++++++++------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/open-weather-connector-product/README.md b/open-weather-connector-product/README.md index c024165..c10f5a0 100644 --- a/open-weather-connector-product/README.md +++ b/open-weather-connector-product/README.md @@ -1,6 +1,6 @@ -# Open Weather Connector +# OpenWeather 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: +Harness the power of freely available weather data in your business processes with OpenWeather! This Axon Ivy connector 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. @@ -8,12 +8,11 @@ Harness the power of freely available weather data in your applications with the * **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. - -
+* Supports you with an easy-to-copy demo implementation to reduce your integration effort. ## Demo -Within the demo, users can access to retrieve comprehensive **5-day weather forecasts** for any global location. Follow these straightforward steps: +Within this demo, users can access comprehensive **5-day weather forecasts** for any location worldwide. Follow these simple 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. @@ -22,19 +21,18 @@ Within the demo, users can access to retrieve comprehensive **5-day weather fore ## 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**. +### Application ID +The OpenWeatherMap weather API is not free to use. However, there is a free version with minimal API calls for development purposes. To use the connector, select a suitable API package via the [OpenWeatherMap API Developer](https://openweathermap.org/api) and generate an **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: +##### How to get an API key +1. Login and go to your [OpenWeatherMap 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: +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": +After a **API key** is available, you can store it in your project in the variables.yaml as the variable "openWeatherConnector.appId": ``` @variables.yaml@ -``` -
+``` \ No newline at end of file