Skip to content

Commit

Permalink
Handle feedback of document
Browse files Browse the repository at this point in the history
  • Loading branch information
ndkhanh-axonivy committed Mar 18, 2024
1 parent 554cd2c commit 1c4c9d7
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions open-weather-connector-product/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# 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.
* **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>
* 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.
Expand All @@ -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@
```
<br>
```

0 comments on commit 1c4c9d7

Please sign in to comment.