Skip to content

Commit 34d28d3

Browse files
authored
docs: synthesized README.md
1 parent 6a1de33 commit 34d28d3

1 file changed

Lines changed: 13 additions & 43 deletions

File tree

README.md

Lines changed: 13 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,22 @@
1+
<div align='center'>
2+
13
# :sun_behind_large_cloud:️ Open-Meteo Kotlin Library
24

5+
A Kotlin library for the [Open-Meteo.com](https://open-meteo.com) APIs.
6+
37
[![Kotlin Stability: Beta](https://img.shields.io/badge/stability-beta-AC29EC.svg?logo=kotlin&logoColor=ffffff&logoWidth=12&style=for-the-badge)](https://kotlinlang.org/docs/components-stability.html)&emsp;
4-
[![GitHub license: MIT](https://img.shields.io/github/license/open-meteo/open-meteo-api-kotlin?logo=github&logoWidth=14&style=for-the-badge)](LICENSE.md)&emsp;
58
[![Jitpack.io Version](https://img.shields.io/jitpack/version/com.open-meteo/open-meteo-api-kotlin?logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1MTIgNTEyIj4mZ3Q7PHBhdGggZD0iTTMxNi43OCAyMi44NzVjLTM5LjkzNCA3LjczLTY4LjE2NiAyMy41ODctODUuMDYgNDUuNTk0bDU2LjY4NiAzMi43MThjNy4wODItMy4zNjYgMTQuODUyLTUuMjg4IDIyLjk3LTUuNDA3IDQuNi0uMDY2IDkuMzEyLjQ0NyAxNC4wNjIgMS41OTUgMy41NS0yMS40NTIuOTMtNDYuMzgyLTguNjU3LTc0LjV6bS05Ny4xNTUgNjAuMTg4LTg2Ljk3IDE1MC41NjIgOTMuMTI2IDUzLjgxMyAyMS44NzYtMzcuODc1Yy05LjkzLTkuNzk0LTE0LjA4LTI0LjY5NS0xNC41OTQtNDAuMjItLjYzLTE4Ljk4NiAzLjk4LTQwLjA5OCAxMi41NjMtNTkuMTg3IDYuMzctMTQuMTY3IDE0LjkxLTI3LjI5NCAyNS43Mi0zNy4yMmwtNTEuNzItMjkuODc0ek00MjYuMDk1IDg2Yy0yOS4zOTQgNS42OS01Mi40MjMgMTUuNzk1LTY5LjI4MyAyOS41IDkuMzMgOS44IDE0LjMwMiAyMS43NTggMTUuMjgyIDM0LjAzbDU2LjUzIDMyLjYyNmMxMC42OS0yNS42NzggMTAuNDgzLTU3Ljk5LTIuNTMtOTYuMTU2ek02NC45NjggOTQuMDYzIDI3LjAzIDE1OS43OGwxMDIgNDIuNzUgNjAuODE0LTEwNS4zMUw2NC45NyA5NC4wNjJ6bTI0Ni42MjQgMTkuOTY4Yy02LjUzNS4xMDUtMTIuNTkgMi4yNi0xOC41NjMgNS44NDUtMTEuOTQyIDcuMTctMjIuODc2IDIxLjMzMi0zMC4zNDIgMzcuOTM4LTcuNDY3IDE2LjYwNS0xMS40OCAzNS41MTItMTAuOTcgNTAuOTA2LjUxIDE1LjM3NyA1LjMyMyAyNi4wNjQgMTIuODEzIDMwLjQwNS4wMDguMDA0LjAyNi0uMDA0LjAzMyAwIDcuNTAzIDQuMzE2IDE5LjE1IDMuMTUyIDMyLjcxOC00LjA5NCAxMy41ODQtNy4yNTMgMjcuOTUtMjAuMTY3IDM4LjU5NS0zNC45MzYgMTAuNjQ1LTE0Ljc3IDE3LjQ1LTMxLjM1IDE3LjY4OC00NS4yOC4yMzctMTMuOTMzLTQuNjgzLTI1LjI0Mi0yMC41LTM0LjM3Ni03LjkxLTQuNTY4LTE0LjkzNS02LjUxLTIxLjQ3LTYuNDA3em01OC44MTIgNTYuMTI2Yy0zLjE5OCAxNC4zMTUtMTAuMjk3IDI4LjI4LTE5LjM3NSA0MC44NzUtMTIuMjM2IDE2Ljk4LTI4LjE4IDMxLjUyMi00NC45MzYgNDAuNDctMTMuNzQgNy4zMzgtMjguNzk1IDExLjItNDIuMjggNy40MzhsLTIxLjg0NSAzNy44MTIgOTMuMTI0IDUzLjc4TDQyMiAxOTkuOTRsLTUxLjU5NC0yOS43ODJ6bTU0LjIyIDYyLjYyNS02MC43ODIgMTA1LjM0NSA4OC4wMyA2NyAzNy45MzgtNjUuNzUtNjUuMTg3LTEwNi41OTR6bS0yNzYuNjU3IDMxLjI4MmMtMjIuNDc3IDkuODQtMzkuNzMgMjMuMTQ4LTUxLjgxNCAzOS4zNDRsODcuNSA1MC41M2M4LjA0LTE4LjU4IDExLjA1Mi00MC4wOTggOC41LTY0LjM0MmwtNDQuMTg3LTI1LjUzek04Ny44NzQgMzIwLjIyIDE4LjIyIDQ0MC43OHYzNy4zNDVsODUuODQzLTE0OC41NjMtMTYuMTg4LTkuMzQzem0xNjkuNDA2IDYuOTY3Yy0yMi40OCA5Ljg0LTM5LjcyNSAyMy4xNDMtNTEuODEgMzkuMzQ0bDg3LjUgNTAuNTMzYzguMDQyLTE4LjU5IDExLjA1Ni00MC4xMiA4LjUtNjQuMzc1bC00NC4xOS0yNS41em0tMTM1LjA5IDEyLjg0NC05MCAxNTQuODc2aDIxLjYybDg0LjU5NC0xNDUuNS0xNi4yMi05LjM3NXptMzQuNDM3IDE5Ljg3Ni03Ny43OCAxMzVoMjEuNTZsNzIuMzc2LTEyNS42NTYtMTYuMTU1LTkuMzQ0ek0xOTcuNDcgMzgzLjVsLTYzLjIyIDExMS40MDZoMjEuNWw1Ny45MDYtMTAyLjA2Mi0xNi4xODctOS4zNDR6bTM0LjQzNiAxOS45MDYtNTEuMDYyIDkxLjVoMjEuMzc1bDQ1Ljg3NC04Mi4xODctMTYuMTg4LTkuMzE0em0zNC40MzggMTkuODc1LTM4LjkzOCA3MS42MjZoMjEuMzEzbDMzLjg0My02Mi4yOC0xNi4yMi05LjM0NXoiIGZpbGw9IiNmZmYiLz48L3N2Zz4=&logoWidth=14&style=for-the-badge)](https://jitpack.io/#com.open-meteo/open-meteo-api-kotlin)&emsp;
69
[![GitHub sponsors](https://img.shields.io/github/sponsors/open-meteo?color=d74b9f&logo=githubsponsors&logoColor=white&style=for-the-badge)](https://github.com/sponsors/open-meteo)
710

8-
A Kotlin library for the [Open-Meteo.com](https://open-meteo.com) APIs.
9-
10-
> **Warning**
11-
>
12-
> Because it's still in early development, some breaking changes **WILL** occur.
13-
14-
## :bookmark_tabs: Index
15-
16-
- [:blue_book: Installation](INSTALLATION.md#blue_book-installation)
17-
- [Gradle](INSTALLATION.md#gradle)
18-
- [Android (gradle)](INSTALLATION.md#android)
19-
- [Maven](INSTALLATION.md#maven)
20-
- [:green_book: Usage](#green_book-usage)
21-
- [:memo: TODO](https://github.com/users/DadiBit/projects/1)
22-
- [:balance_scale: Legal](#balance_scale-legal)
23-
- [LICENSE](LICENSE.md)
24-
- [ATTRIBUTIONS](ATTRIBUTIONS.md)
25-
26-
## :green_book: Usage
27-
28-
Here's a quick example:
29-
```kotlin
30-
import com.openmeteo.api.OpenMeteo
31-
32-
OpenMeteo("Amsterdam")
33-
.currentWeather(TemperatureUnit.Fahrenheit)
34-
.getOrNull()?.run {
35-
36-
println("+-- $city")
37-
println("| Coordinates: [ $latitude, $longitude ]")
38-
currentWeather?.run {
39-
println("| Timestamp: $time")
40-
println("| Temperature: $temperature°F")
41-
println("| Message: $weatherCode")
42-
println("+")
43-
}
44-
45-
}
46-
```
11+
---
4712

48-
<!-- The library includes some examples in the [tests](lib/src/test/kotlin/com/openmeteo/api). -->
13+
### :link: Quick links
4914

50-
## :balance_scale: Legal
15+
[:wrench: Installation](../../wiki/Installation)&emsp;
16+
[:green_book: Examples](../../wiki/Examples)&emsp;
17+
[:memo: TODO](https://github.com/users/DadiBit/projects/1)&emsp;
18+
[:raised_hands: Contributing](CONTRIBUTING.md)&emsp;
19+
[:balance_scale: License](LICENSE.md)&emsp;
20+
[:page_facing_up: Attributions](ATTRIBUTIONS.md)
5121

52-
You are free to do pretty much whatever you want with this library, as long as you respect the [LICENSE](LICENSE.md) and the [ATTRIBUTIONS](ATTRIBUTIONS.md).
22+
</div>

0 commit comments

Comments
 (0)